Skip to content

docs: the README's CLI section lists context, report and graph - #2009

Open
Ayingxizhao wants to merge 1 commit into
AxiomCodeAI:devfrom
Ayingxizhao:docs/readme-cli-commands
Open

Ayingxizhao wants to merge 1 commit into
AxiomCodeAI:devfrom
Ayingxizhao:docs/readme-cli-commands

Conversation

@Ayingxizhao

@Ayingxizhao Ayingxizhao commented Nov 2, 2026 •

Copy link
Copy Markdown

Fixes #2008

What changed

README only, in the CLI commands section:

  • adds table rows for context, report and graph, in the order axiomcode help prints them and in its wording
  • names impact, path and tests in the intro, so "numbered places" covers only those three
  • adds context(task) and link(site, target) to the MCP tool sentence

value is left to #1961, which edits the same section, so whichever merges second may need a small conflict fix.

Why the goldens moved, or why they did not

No golden moved. Nothing under test/*/expected changed.

Evidence

All nine public verbs were run through bin/axiomcode on a small synthetic TypeScript project, covering the new rows:

  • context "<task>" with and without --source printed the call flow
  • graph wrote .axiomcode/graph/graph.html and printed its path; the page was not opened in a browser
  • report wrote .axiomcode/assists.html with 0 chains, as no agent session had recorded any, so a populated report was not seen

tests/manifests.py, tests/mcp_docs.py and tests/front_door.py pass. tests/surfaces.py has one failure, README.md CLI section: names the flag --fresh, for a line this PR does not touch.

Checklist

  • The three suites pass locally against the parser commit in .github/parser-ref: not run, this changes the README only (.github/parser-ref is also not in the repo)
  • Any golden that moved is explained above: none moved
  • A fix validated on more than one shape, so this is not overfitting to one case: not applicable, docs only
  • Labels set, including the front end (java / python / typescript): my account cannot set labels here; no front end applies

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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.

README: the CLI section leaves out context, report and graph

1 participant