CLI Reference

Quick reference (TOML)

# specbird <command> [options]
# install | publish | annotate | search | require | graph

specbird install

specbird install @namespace/name[@version]

Installs a spec and its dependencies to docs/. Writes a specbird.lock file.

specbird publish [--dry-run]

Publishes the current directory's spec to the registry. Reads spec.toml.

specbird search "credential proxy"

Searches the registry and returns ranked results with install commands.

specbird annotate @namespace/name@version "summary"

Annotates your usage of a spec with a summary. Stored in docs/ alongside the spec.

specbird require @namespace/name

Adds a spec dependency to spec.toml without installing. Use specbird install after.

specbird graph [@namespace/name]

Shows the knowledge graph for a spec or your full installed spec graph.