Spec Format

Quick reference (TOML)

[spec]
name        = "@namespace/name"
version     = "1.0.0"
description = "One line."
license     = "MIT"
no_ai_train = false
keywords    = ["tag1", "tag2"]

[spec.requires]
"@common/aho-corasick" = "^2.0.0"

[index]
sections = ["Problem", "Architecture", "Key Decisions", "Edge Cases", "Examples"]

spec.toml

Every spec begins with a spec.toml frontmatter file. Required fields: name, version, license.

Versioning

Specbird uses semantic versioning (semver). Patch releases (1.0.x) for corrections. Minor (1.x.0) for new sections. Major (x.0.0) for breaking changes to the spec's interface.

Sections

Define sections in [index]. Section names become anchors in the spec page and are available for targeted fetches:

GET registry.specbird.com/@namespace/name?section=architecture

Licensing

Supported licenses: MIT, Apache-2.0, BSD-2-Clause, ISC, specbird-attribution, commercial. Use specbird-attribution to allow use with credit; use commercial for paid access only.

no_ai_train flag

Set no_ai_train = true to opt out of AI training use. This is displayed prominently in the registry and respected by downstream consumers that implement the specbird honor system.