Skip to content
handover

CLI command reference

Generated: 2026-03-03T09:09:09.072Z

This page is produced by npm run docs:commands.

handover root help

Section titled “handover root help”
> handover-cli@0.1.0 dev
> tsx src/cli/index.ts --help


Usage: handover [options] [command]


Generate comprehensive codebase documentation for handover


Options:
  -V, --version             output the version number
  --provider <provider>     LLM provider override
  --model <model>           Model override
  --audience <mode>         Audience mode: human (default) or ai
  -v, --verbose             Show detailed output
  -h, --help                display help for command


Commands:
  init [options]            Create .handover.yml configuration file
  generate [options]        Analyze codebase and generate documentation
  analyze [options]         Run static analysis on the codebase
  estimate [options]        Estimate token count and cost before running
  reindex [options]         Build or update vector search index from generated
                            documentation
  embedding-health          Run embedding provider health checks
  search [options] <query>  Search generated documentation using semantic
                            similarity
  serve [options]           Start MCP server over stdio (default) or HTTP
                            transport
  auth                      Manage authentication for LLM providers

handover init

Section titled “handover init”
> handover-cli@0.1.0 dev
> tsx src/cli/index.ts init --help


Usage: handover init [options]


Create .handover.yml configuration file


Options:
  --yes       Skip prompts and write a default config (for CI/non-interactive
              environments)
  -h, --help  display help for command

handover generate

Section titled “handover generate”
> handover-cli@0.1.0 dev
> tsx src/cli/index.ts generate --help


Usage: handover generate [options]


Analyze codebase and generate documentation


Options:
  --provider <provider>  LLM provider override
  --model <model>        Model override
  --only <docs>          Generate specific documents (comma-separated)
  --audience <mode>      Audience mode: human (default) or ai
  --static-only          Run static analysis only (no AI cost)
  --no-cache             Discard cached results and run all rounds fresh
  --since <ref>          Only re-analyze files changed since this git ref (e.g.
                         HEAD~3, main, v1.0)
  --stream               Show streaming token output during AI rounds
  -v, --verbose          Show detailed output
  -h, --help             display help for command

handover analyze

Section titled “handover analyze”
> handover-cli@0.1.0 dev
> tsx src/cli/index.ts analyze --help


Usage: handover analyze [options]


Run static analysis on the codebase


Options:
  --json               Output JSON to stdout instead of markdown file
  --git-depth <depth>  Git history depth: "default" (6 months) or "full"
                       (default: "default")
  -v, --verbose        Show detailed output
  -h, --help           display help for command

handover estimate

Section titled “handover estimate”
> handover-cli@0.1.0 dev
> tsx src/cli/index.ts estimate --help


Usage: handover estimate [options]


Estimate token count and cost before running


Options:
  --provider <provider>  Provider to estimate for
  --model <model>        Model to estimate for
  -v, --verbose          Show detailed output
  -h, --help             display help for command

handover reindex

Section titled “handover reindex”
> handover-cli@0.1.0 dev
> tsx src/cli/index.ts reindex --help


Usage: handover reindex [options]


Build or update vector search index from generated documentation


Options:
  --force                  Re-embed all documents (ignore change detection)
  --embedding-mode <mode>  Embedding locality mode: local-only, local-preferred,
                           or remote-only
  -v, --verbose            Show detailed output
  -h, --help               display help for command
Section titled “handover search”
> handover-cli@0.1.0 dev
> tsx src/cli/index.ts search --help


Usage: handover search [options] <query>


Search generated documentation using semantic similarity


Options:
  --mode <mode>            Search mode: fast (default) or qa (default: "fast")
  --embedding-mode <mode>  Embedding locality mode: local-only, local-preferred,
                           or remote-only
  --top-k <n>              Number of results to return (default: 10) (default:
                           10)
  --type <type>            Filter by document type (repeatable). Valid types:
                           project-overview, getting-started, architecture,
                           file-structure, features, modules, dependencies,
                           environment, edge-cases-and-gotchas,
                           tech-debt-and-todos, conventions, testing-strategy,
                           deployment (default: [])
  -h, --help               display help for command


Examples:
  $ handover search "authentication"
  $ handover search "How does the DAG orchestrator work?" --mode qa
  $ handover search "dependency graph" --mode fast --top-k 5
  $ handover search "system design" --type architecture --type modules

handover serve

Section titled “handover serve”
> handover-cli@0.1.0 dev
> tsx src/cli/index.ts serve --help


Usage: handover serve [options]


Start MCP server over stdio (default) or HTTP transport


Options:
  --transport <transport>  Transport mode: stdio (default) or http
  --allow-origin <origin>  Allow cross-origin requests from this origin
                           (repeatable, overrides config) (default: [])
  --port <port>            HTTP listen port (default: 3000)
  --host <host>            HTTP listen host (default: 127.0.0.1)
  -h, --help               display help for command