Skip to content

docs: fix groups add syntax in README (fixes #107)#108

Merged
flupkede merged 1 commit into
developfrom
features/documentation_align
Jun 6, 2026
Merged

docs: fix groups add syntax in README (fixes #107)#108
flupkede merged 1 commit into
developfrom
features/documentation_align

Conversation

@flupkede

@flupkede flupkede commented Jun 6, 2026

Copy link
Copy Markdown
Owner

Fix

Corrects the codesearch groups add example in README.md to match the actual CLI behavior.

Issue

Fixes #107

What changed

  • Line 356: codesearch groups add my-group repo1 repo2 repo3codesearch groups add my-group --aliases repo1 repo2 repo3

The CLI only accepts the group name as a positional argument. Members must be added via the --aliases (-a) flag.

Documentation audit

Full audit of all CLI examples in README.md against actual --help output — no other discrepancies found:

  • ✅ All index add/rm/list/prune/symbol examples match CLI
  • ✅ All serve, mcp, search, doctor, cache references match CLI
  • ✅ All MCP configuration JSON snippets are correct
  • ✅ CLI Reference table at line 378–391 is accurate
  • ✅ CHANGELOG.md has no stale groups add syntax
  • ✅ README_CSharp.md has no groups add references

QC

cargo fmt ✅ | cargo check ✅ | cargo clippy ✅ | 432/432 tests passed ✅

@flupkede flupkede merged commit af8dc25 into develop Jun 6, 2026
5 checks passed
@flupkede flupkede deleted the features/documentation_align branch June 6, 2026 10:39
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