Browse documentation

CLI reference

Commands by task, expected results, and daemon lifecycle.

Run commands from the initialized project root. Replace angle-bracket placeholders before running them. errata --help describes your installed build.

Setup and lifecycle

Command Result
errata --version Installed CLI version
errata init Profile and hook setup; prompts for login if needed
errata init --no-login Setup without requiring login
errata init --no-login --skip-hooks Profile setup without agent configuration
errata install-hooks <harness> Configure claude, codex, cursor, opencode, or print aider guidance
errata start Manually start or attach to the singleton; useful without local MCP or when auto-start fails
errata mcp Serve local stdio MCP and automatically start the daemon if absent
errata status Workspace, graph, daemon, consent, cloud state
errata projects Initialized workspaces
errata stop Stop the daemon, affecting its other workspaces too
errata dash Run the singleton in the foreground

Read and inspect

Command Result
errata search "<words>" Matching graph nodes
errata burst "<words-or-id>" --local Local neighborhood and selected seed
errata burst "<words-or-id>" Neighborhood; may include collective retrieval
errata locate <relative-path> File and immediate symbols
errata neighbors <id> --depth 2 Graph neighbors
errata g index Graph path reference
errata g problems Problem states and IDs
errata g why/<id> Causal and resolution neighborhood
errata g <path> --materialize Write a result under .errata/g/
errata report Write an HTML snapshot and print its path
errata reindex --no-embed Refresh code indexing without code-node embedding

A fresh graph can contain code before lessons. Embedding availability affects semantic ranking.

Identity and diagnostics

Command Result
errata login Browser-assisted sign-in
errata whoami Server-resolved identity, visibility, and contribution target
errata doctor --json Installation and cloud diagnostics; nonzero when required checks fail
errata profile Named installation profiles
errata profile use <name> Change active credential profile
errata use Available agent identities and current selection
errata link Explicit project-link workflow for the installed release
errata logout Clear local cloud credentials

A profile changes credentials, not the filesystem workspace. Check status for the project and whoami for the effective cloud target. Newer builds support workspace-to-profile bindings; inspect installed help before using them.

sh
errata privacy
errata consent sync on
errata consent telemetry off
errata consent packages off
errata sync now

Run only the toggles you intend. errata consent all off disables all three machine-level channels. Inspect sync results for uploads, rejections, and skips.

Updates

sh
errata update --check
errata update

Restart the daemon afterward. See Install the CLI for channels and Troubleshooting for diagnosis.