Skip to content
Speccy

CLI

This page lists each command of the speccy binary, as speccy help prints it. The TUI lists the keys of the terminal UI.

Usage:
  speccy [--dir folder] [--addr host:port] [--no-open]   Start local mode and open the browser.
  speccy serve [--dir folder] [--addr host:port]         Start local mode without opening a browser.
  speccy serve --hosted                                  Start hosted mode (SPECCY_ environment variables).
  speccy init                                            Write .speccy.yaml and ignore .speccy/state/.
  speccy add <url> [--profile <key>]                     Make a GitHub source from a URL, and sync it once.
  speccy init --github                                   Adopt this repo: map its docs, relax the checks that
                                                         fail today, and write the Action's workflow.
  speccy review <path…> [--format text|json|md] [--summary] [--server URL] [--adopt]
                [--stages lint,rubric,grounding,divergence,coherence] [--enforcement advisory|blocking]
                                                         Review bundles. Exit codes: 0 Build Ready or advisory,
                                                         1 Not Build Ready in blocking mode, 2 usage, 3 run error.
                                                         --adopt writes the type and the size the review used
                                                         into each doc's frontmatter.
  speccy action [--server URL] [--stages …] [--enforcement advisory|blocking] [--verify]
                                                         The GitHub Action: review the bundles a pull request
                                                         changes, and comment on it. --verify runs the
                                                         verification gate instead of the review.
  speccy tui                                             Open the terminal UI.
  speccy mcp                                             Run the MCP server over stdio.
  speccy profile validate <file>                         Check a profile file.
  speccy export <path> --format zip|html                 Export a bundle, or its HTML report.
  speccy handoff <path> --out <folder>                   Write a bundle's build packet for a coding agent.
                [--label <name>] [--acknowledged]
  speccy report <path> --handoff <id> --text <text>      Report what a build learned about the doc.
                [--blocked | --note] [--section "A › B"] [--trace-id REQ-012]
  speccy verify <path> [<GitHub URL or folder>]          Verify one build against the bundle. With no URL,
                                                         the repo the doc's implemented-by link names.
  speccy admin invite --role admin|member                Print an invite link (hosted).
  speccy admin reset-link <email>                        Print a password reset link (hosted).
  speccy version                                         Print the version.


Local mode serves the bundles under --dir (default: the current folder). The other commands work
on the folder with .speccy.yaml, from the current folder up, or else on the current folder.