From 2420dae29618bdcc9d894e140fe9219365ce21c1 Mon Sep 17 00:00:00 2001 From: asdacdsfca Date: Sun, 1 Nov 2026 23:33:58 -0500 Subject: [PATCH] docs: the README's CLI section lists context, report and graph Co-Authored-By: Claude Opus 5.5 --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 88b6335ea..68cf54a0e 100644 --- a/README.md +++ b/README.md @@ -311,9 +311,10 @@ about one change had to read 95 of 43,793 methods, and every true direct caller ## CLI commands -Three questions, each answered as numbered places with the code of the function each one sits in. The MCP server -offers the same three as tools: `impact(name)`, `path(start, end)` and `tests()`. Finding where code lives is -left to your own search: bring the name you found to these commands. +Three questions, `impact`, `path` and `tests`, each answered as numbered places with the code of the function each +one sits in. The MCP server offers the same three as tools: `impact(name)`, `path(start, end)` and `tests()`, with +`context(task)` and `link(site, target)` beside them. Finding where code lives is left to your own search: bring +the name you found to these commands. | command | what it answers | |---|---| @@ -321,8 +322,11 @@ left to your own search: bring the name you found to these commands. | `axiomcode impact` | the same for the declarations your uncommitted edits changed; the answer starts with `your edits:` | | `axiomcode path ` | how A reaches B: every hop of the call chain, with the code at each call | | `axiomcode tests` | the tests your uncommitted edits reach, and a last `run:` line with the command that runs them | +| `axiomcode context ""` | how something works, as a narrative: the files and callables the task touches and, for a how-does-X-work question, the call flow step by step; `--source` carries each step's code | | `axiomcode link ` | record where a call the graph could not resolve lands (kept in `axiomcode-links.tsv`); impact, path and tests then walk it, labelled `[asserted]`. Alone, lists the links and whether each was applied | | `axiomcode index` | build the graph explicitly (the first query builds it too); `--lang`, `--src` and `--library` narrow it | +| `axiomcode report` | where an answer verifiably helped: every Redirected / Helped / Useful chain the end-of-turn receipts recorded, as one HTML page (`.axiomcode/assists.html`) | +| `axiomcode graph` | the codebase as one interactive page: directories, files, types and methods, and the call edges between them. Prints the page's path, `.axiomcode/graph/graph.html` | A name is written the way it appears in the code: `Owner.method`, `method`, `Type`, `Owner.field`, or `file.py:123`. It is resolved exactly; a miss lists the nearest names. `axiomcode help ` prints one