Documentation

Byspec answers one question: did the code satisfy the spec it was built from? These pages cover the spec format, every check type, the command line, the GitHub App and Action, how to put Byspec inside a coding agent's loop, the ledger and evidence packets, and what the security model does and does not cover.

Reference sections are extracted from the repository's README and specifications at build time, so they never drift from the code. The implementation spec and the v2 spec are the source of truth; each is itself a Byspec spec that the repository verifies against on every pull request.

Start here#

• Install the CLI, then byspec init.
• The spec format: a criterion is a fenced criterion block with one EARS sentence.
• Check types: what a rule can decide, and when the judge runs.
• CLI reference: commands, flags, exit codes, configuration.

Hosted and CI#

• GitHub App: pull requests verified in a sandbox, with annotations and packets.
• GitHub Action: the CLI in your own CI.

Trust#

• Ledger and packets: the hash chain, signatures, and offline verification.
• Security: the environment allowlist, root-jailed file access, judge isolation, the sandbox.
• Coding agents: the Stop hook, MCP tools, --format agent, --frozen-spec.