Getting Started

[spec]
name    = "@namespace/name"
version = "1.0.0"
license = "MIT"

[next]
action  = "annotate"
command = "specbird annotate @namespace/name@1.0.0 \"summary\""

Install the CLI

brew install specbird
# or: npm install -g specbird

Install a spec

Install a spec into your project's docs/ directory:

specbird install @attia/byte-exact-scanner

This fetches the spec, resolves its dependencies, and writes markdown files to docs/. Your AI agent reads from docs/ automatically.

Annotate your implementation

After implementing, annotate with a summary so future agents understand how you used it:

specbird annotate @attia/byte-exact-scanner@1.2.0 "Used Aho-Corasick for credential scanning in the auth pipeline"

Publish a spec

specbird publish

Run from your spec's directory. Requires a spec.toml file in the current directory.