Summary
The validate subcommand exists in the CLI dispatch but is documented nowhere: README has no entry, DEVELOPER_GUIDE has no entry, the bash/zsh completion scripts don't list it, and cdidx --help doesn't include it in the subcommand summary table. Discoverability is zero — the only way to find it is to read QueryCommandRunner.cs or call it by accident. For an integrity-check command this is the opposite of what we want; it should be on the front page.
Where
src/CodeIndex/Cli/QueryCommandRunner.cs (validate dispatch — actually present)README.md (no validate section)DEVELOPER_GUIDE.md (no validate section)src/CodeIndex/Cli/ConsoleUi.cs:330-450 (PrintUsage subcommand list)bash-completions.sh / zsh equivalents
Suggested approach
(1) Add a ## Validate section to README under the user-facing commands listing what validate checks (graph integrity, FTS triggers, schema invariants, fold consistency, etc.) and the exit codes. (2) Add it to DEVELOPER_GUIDE in the operations section. (3) Add it to the PrintUsage subcommand summary table in ConsoleUi.cs. (4) Add a validate --help per-subcommand block once #C291 (per-subcommand help) lands. (5) Add it to the shell completion scripts. (6) Wire a docs regression test that fails if a known subcommand is missing from README or PrintUsage.
Summary
The
validatesubcommand exists in the CLI dispatch but is documented nowhere: README has no entry, DEVELOPER_GUIDE has no entry, the bash/zsh completion scripts don't list it, andcdidx --helpdoesn't include it in the subcommand summary table. Discoverability is zero — the only way to find it is to readQueryCommandRunner.csor call it by accident. For an integrity-check command this is the opposite of what we want; it should be on the front page.Where
src/CodeIndex/Cli/QueryCommandRunner.cs(validate dispatch — actually present)README.md(no validate section)DEVELOPER_GUIDE.md(no validate section)src/CodeIndex/Cli/ConsoleUi.cs:330-450(PrintUsage subcommand list)bash-completions.sh/ zsh equivalentsSuggested approach
(1) Add a
## Validatesection to README under the user-facing commands listing whatvalidatechecks (graph integrity, FTS triggers, schema invariants, fold consistency, etc.) and the exit codes. (2) Add it to DEVELOPER_GUIDE in the operations section. (3) Add it to thePrintUsagesubcommand summary table in ConsoleUi.cs. (4) Add avalidate --helpper-subcommand block once #C291 (per-subcommand help) lands. (5) Add it to the shell completion scripts. (6) Wire a docs regression test that fails if a known subcommand is missing from README orPrintUsage.