Skip to content

docs: fix CLI reference for v0.7.7 subcommand interface #17

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
yamchabot wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs: fix CLI reference for v0.7.7 subcommand interface #17

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a888a56
docs: fix CLI reference for v0.7.7 subcommand interface
Feb 22, 2026
6d22377
Update docs/quickstart.md
Kadajett Feb 23, 2026
abf656c
Update docs/quickstart.md
Kadajett Feb 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 29 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,32 +6,47 @@ Semantic code analyzer that produces compressed TOON (Text Object-Oriented Notat

```bash
cargo build --release
# Binaries land in target/release/
```

## Binaries

The project builds three binaries:
The project builds four binaries:

| Binary | Purpose |
|--------|---------|
| `semfora-engine` | CLI for semantic analysis, indexing, and querying |
| `semfora-engine-server` | MCP server for AI agent integration |
| `semfora-daemon` | WebSocket daemon for real-time updates |
| `semfora-engine` | Main CLI: analysis, indexing, querying, and MCP server |
| `semfora-daemon` | WebSocket daemon for real-time index updates |
| `semfora-benchmark-builder` | Benchmark tooling |
| `semfora-security-compiler` | Security pattern compiler |

> **Note:** The MCP server is built into `semfora-engine` as the `serve` subcommand.
> There is no separate `semfora-engine-server` binary.

## Usage

```bash
# Analyze a single file
semfora-engine path/to/file.rs
semfora-engine analyze path/to/file.rs

# Analyze a directory
semfora-engine analyze ./src

# Analyze uncommitted changes
semfora-engine analyze --uncommitted

# Generate a semantic index for the current project
semfora-engine index generate .

# Analyze a directory and create sharded index
semfora-engine --dir . --shard
# Search for symbols by name
semfora-engine search "authenticate"

# Query the index
semfora-engine --search-symbols "authenticate"
semfora-engine query overview
semfora-engine query symbol --help

# Start MCP server (for AI agents)
semfora-engine-server
# Start MCP server (for AI coding assistants)
semfora-engine serve --repo /path/to/project

# Start WebSocket daemon (for real-time updates)
semfora-daemon
Expand Down Expand Up @@ -397,10 +412,12 @@ src/
| Document | Description |
|----------|-------------|
| [Quick Start](docs/quickstart.md) | Get up and running in 5 minutes |
| [CLI Reference](docs/cli.md) | Complete CLI usage, flags, and examples |
| [CLI Reference](docs/cli.md) | Complete CLI usage, subcommands, and examples |
| [Features](docs/features.md) | Incremental indexing, layered indexes, risk assessment |
| [MCP Tools Reference](docs/mcp-tools-reference.md) | All MCP tools for AI agent integration |
| [MCP Workflows](docs/mcp-workflows.md) | Common MCP usage patterns |
| [WebSocket Daemon](docs/websocket-daemon.md) | Real-time updates, protocol, and query methods |
| [Adding Languages](docs/adding-languages.md) | Guide for adding new language support |
| [Engineering](docs/engineering.md) | Implementation details and status |
| [Architecture](docs/architecture.md) | Implementation details and design |

## License
Loading