Repository navigation
docs: five reference examples use flags or arguments that do not exist #1402
Description
All verified by execution; all exit 2.
| Doc | Documented | Actual |
|---|---|---|
reference/cli.md:94 |
cgc report [--include-java] |
flag is --java |
reference/cli.md:30 |
cgc index [--force] [--dependency] |
no --dependency; the real flag --summarize is undocumented |
CLI_COMPLETE_REFERENCE.md:56 |
cgc analyze overrides <class> --file |
no --file; the arg is a function name, not a class |
CLI_COMPLETE_REFERENCE.md:69 |
cgc find content <text> --case-sensitive |
no such flag (it is valid on find pattern) |
CLI_COMPLETE_REFERENCE.md:116 |
cgc visualize [query], "Generate link to Neo4j Browser" |
takes no positional; launches a local UI server |
$ cgc report --include-java
│ No such option: --include-java (Possible options: --java) │ EXIT=2
$ cgc analyze overrides area --file foo.py
│ No such option: --file │ EXIT=2
$ cgc visualize "MATCH (n) RETURN n"
│ Got unexpected extra argument(s) (MATCH (n) RETURN n) │ EXIT=2
The analyze overrides row is doubly wrong: passing a class name, as documented, returns zero results silently.
Audit environment
| Version | codegraphcontext 0.5.2 (PyPI) |
| Commit | df3af04 |
| Backend | FalkorDB Lite (falkordblite 0.9.0), Python 3.12.3, Linux |
| Corpus | the CodeGraphContext repo itself — 784 files, 23 languages, 5,501 Function nodes |
Audit ID U-H8 · severity high · from an end-to-end audit of CGC 0.5.2 (63 findings). Reported with the reproduction as run.
Activity
github-actions commentedon Jul 26, 2026
Hi! 👋 Join our CodeGraphContext Discord channel to collaborate: https://discord.gg/dR4QY32uYQ
docs(cli): correct command reference examples (#1420)