docs: fix CLI reference for v0.7.7 subcommand interface#17
docs: fix CLI reference for v0.7.7 subcommand interface#17yamchabot wants to merge 3 commits intoSemfora-AI:mainfrom
Conversation
- Remove references to non-existent semfora-engine-server binary (MCP server is now semfora-engine serve) - Replace all flag-based syntax (--dir, --shard, --search-symbols, etc.) with correct subcommand syntax (index generate, search, query, etc.) - Document all subcommands: analyze, search, query, trace, validate, index, cache, serve, lint, test, commit - Add accurate binary table (4 binaries, not 3) - Fix MCP client configuration examples - Add complete option tables for each command - Update docs table in README to reference existing files only
There was a problem hiding this comment.
Pull request overview
This pull request updates the documentation to reflect the v0.7.7-beta CLI interface changes. The project moved from a flag-based CLI (--dir --shard, --search-symbols) to a modern subcommand-based architecture (semfora-engine index generate, semfora-engine search). Additionally, the separate semfora-engine-server binary was consolidated into the main semfora-engine binary as the serve subcommand.
Changes:
- Updated binary count from 3 to 4 (added benchmark and security compiler binaries to documentation)
- Converted all command examples from flag-based to subcommand syntax across three documentation files
- Updated MCP server configuration examples to use
semfora-engine serveinstead of referencing the removedsemfora-engine-serverbinary
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| README.md | Updated binary table (4 binaries instead of 3), converted usage examples to subcommand syntax, updated documentation links |
| docs/quickstart.md | Complete rewrite with subcommand syntax for all operations, added MCP tools table (18 tools), expanded command examples |
| docs/cli.md | Full rewrite with comprehensive subcommand reference documentation, MCP server configuration examples, option tables for all commands |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| | `index` | Refresh/check the semantic index | | ||
| | `test` | Run or discover tests | | ||
| | `lint` | Run linters (auto-detects available tools) | | ||
| | `server_status` | Server status and layer info | |
There was a problem hiding this comment.
The table lists 18 MCP tools, but server_status and get_languages are documented here while security is not. However, the existing mcp-tools-reference.md file (not modified in this PR) incorrectly includes security which is not exposed via MCP, and is missing server_status and get_languages. Consider updating mcp-tools-reference.md in a follow-up to match this correct list of 18 tools.
There was a problem hiding this comment.
@copilot open a new pull request to apply changes based on this feedback
| "mcpServers": { | ||
| "semfora-engine": { | ||
| "type": "stdio", | ||
| "command": "/path/to/semfora-engine", |
There was a problem hiding this comment.
The Claude Desktop configuration uses /path/to/semfora-engine here, but in quickstart.md line 174, it uses /path/to/semfora-engine/target/release/semfora-engine. These should be consistent across both documentation files. The full path is more accurate for users who built from source.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2 participants
Summary
The documentation was significantly out of date for the current
v0.7.7-betaCLI interface. This PR fixes all three main docs files.Changes
Problem
The docs described a flag-based CLI that no longer exists, and referenced a binary (
semfora-engine-server) that was consolidated into the main binary.Fixed
README.mdsemfora-engine-server→semfora-engine serve)docs/quickstart.md(full rewrite)--dir --shardstyle flags replaced withsemfora-engine index generate--search-symbolsreplaced withsemfora-engine search--get-overviewetc replaced withsemfora-engine query overviewtrace,validate,cachesubcommand examplesdocs/cli.md(full rewrite)servesubcommand docs with MCP client config examplesOld vs New
semfora-engine --dir . --shardsemfora-engine index generate .semfora-engine --search-symbols "x"semfora-engine search "x"semfora-engine --get-overviewsemfora-engine query overviewsemfora-engine-serversemfora-engine servesemfora-engine --uncommittedsemfora-engine analyze --uncommittedsemfora-engine --cache-infosemfora-engine cache infoAll changes were verified by building
v0.7.7-betafrom source and running every command shown.