Skip to content

docs: align README with actual CLI surface - #18

Merged
kanfil merged 1 commit into
mainfrom
docs/align-readme-cli-surface
Sep 29, 2026
Merged

kanfil merged 1 commit into
mainfrom
docs/align-readme-cli-surface

Conversation

@kanfil

@kanfil kanfil commented Sep 29, 2026

Copy link
Copy Markdown
Member

Verified every claim against code (audit of v2.2.0) and realigned the README:

Fixed

  • skill add → skills add — no singular skill command exists (dispatch.mjs has no case; it silently prints help)
  • "alias bin + npm shim during 1.x" framing — stale at v2.2.0, both still ship
  • agent table gemini row — registry key is gemini-cli, run profile key is gemini; documented the split and adjusted "4 agents support run" framing

Added (existed in code, undocumented)

  • team command tree (setup/update/repair + flags)
  • workspace command tree (setup/init/status, workspace.yml schema, ADLC_WORKSPACE_FILE, --dry-run)
  • top-level run alias for agent run (ADR-368)
  • .adlc/init-options.json section
  • workflow env vars (ADLC_WORKFLOW_SESSION/_RUN_ID/_LEASE_TTL) and SIGINT/SIGTERM clean pause
  • --pull flag in the skill flags table

Refreshed

  • events tables keyed to gemini-cli; generated-definition home .adlc/workflows/<run_id>/ (ADR-391-amendment)

No behavior changes — docs only.

- fix 'skill add' -> 'skills add' (no singular command exists)
- document team / workspace command trees + top-level run alias
- document .adlc/init-options.json, workflow env vars, clean SIGINT pause
- note gemini/gemini-cli key split (run profile vs registry key)
- refresh agent tables to gemini-cli key; drop stale 'during 1.x' framing
@kanfil
kanfil merged commit 8151211 into main Sep 29, 2026
9 checks passed
@kanfil
kanfil deleted the docs/align-readme-cli-surface branch September 29, 2026 18:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant