Current generated artifact index¶
This page indexes the files the current SpecBind CLI installs and the artifacts
the current CLI and product-managed skills maintain. {{SPEC_DIR}} is configured
in .specbind.json and defaults to .specbind for a new installation.
For the workflows that own these files, see the current generated skill index. For their design history and detailed lifecycle, see the target artifact catalog.
Installation surface¶
specbind install creates absent project-owned settings, refreshes
product-managed skills, and optionally maintains a marked block in each selected
agent's root instruction file. Existing project-owned settings are kept.
specbind remove-agent plans by default and removes only one selected agent's
exact product-managed Skills, role files, marked instruction block, and config
entries when rerun with --apply. specbind uninstall --knowledge retain|remove
likewise plans before applying and requires an explicit choice to retain or
remove the configured complete {{SPEC_DIR}} knowledge bundle. Both operations
use .specbind.json as the final completion marker and never uninstall the
machine-level binary.
| Target | Current behavior |
|---|---|
.specbind.json |
Versioned project configuration containing the Spec root, artifact language, selected agents, optional project-instruction integration, and optional agent-role capability overrides. |
{{SPEC_DIR}}/settings/templates/specs/requirements.md |
Project-owned Requirements structure and authoring scaffold. |
{{SPEC_DIR}}/settings/templates/specs/design.md |
Project-owned Design structure and authoring scaffold. |
{{SPEC_DIR}}/settings/templates/specs/ui.md |
Project-owned conditional screen-design scaffold; the selection Rule decides whether it applies to one Spec. |
{{SPEC_DIR}}/settings/templates/roadmap.md |
Project-owned scaffold for milestone-wide Roadmap requests and rationale; live Roadmap Front Matter remains CLI-owned. |
{{SPEC_DIR}}/settings/rules/ears-format.md |
Project Requirements style preferences. |
{{SPEC_DIR}}/settings/rules/design-principles.md |
Project Design preferences. |
{{SPEC_DIR}}/settings/rules/design-template-selection.md |
Required classification and applicability policy for every design/<artifact_id> template. |
{{SPEC_DIR}}/settings/rules/contract-principles.md |
Project seam and compatibility policy. |
{{SPEC_DIR}}/settings/rules/tasks-generation.md |
Project task-decomposition preferences. |
{{SPEC_DIR}}/settings/rules/steering-principles.md |
Project steering-authoring preferences. |
{{SPEC_DIR}}/settings/rules/language-style.md |
Optional cross-artifact prose preferences; the Japanese default is installed only for ja. |
{{SPEC_DIR}}/settings/adapters/release.md |
Project-owned release preparation, publication, verification, and cleanup guidance. |
{{SPEC_DIR}}/settings/adapters/git.md |
Active default policy that commits each eligible workflow unit locally, without pushing or rewriting history. |
{{SPEC_DIR}}/settings/adapters/deferred.md |
Project destination for real review findings that do not hold a gate. |
{{SPEC_DIR}}/settings/adapters/validation.md |
Optional project-specific procedures added to final Spec implementation validation. |
.claude/skills/<skill>/SKILL.md and known references/ |
Product-managed Claude Code rendering of each of the 15 embedded Skill packages. |
.agents/skills/<skill>/SKILL.md and known references/ |
Product-managed Codex rendering of each of the 15 embedded Skill packages. |
.codex/agents/specbind-*.toml |
Product-managed Codex role adapters for planning, implementation, review, diagnosis, and bounded research; model capability may be overridden through .specbind.json. |
.claude/agents/specbind-*.md |
Product-managed Claude Code role adapters for the same five roles; model capability may be overridden through .specbind.json. |
CLAUDE.md / AGENTS.md marked block |
Optional product-managed project instruction block; surrounding project text is preserved. |
The binary also embeds seven Spec scaffolds (brief, research, requirements,
design/main, design/ui, contract, and implementation-notes/main), four Steering
scaffolds (product, tech, structure, and author-identified document), and
one milestone roadmap scaffold in English and Japanese. template list/read
exposes all of them. Requirements, main Design, conditional UI Design, and the
Roadmap body template are installed by default; a project can override any other selector under
settings/templates/ deliberately. template resolve spec <spec> <selector>
reports the selected source and exact project-root-relative project path without
writing it. template read validates and returns the raw scaffold, including
its variables and instruction comments; the authoring agent materializes it.
template list spec reports Design candidates rather than ordering every one
to be materialized. The required design-template-selection Rule classifies
each design/<artifact_id> as required, conditional, or disabled and
provides project-owned conditions for conditional entries. The CLI validates a
complete one-to-one classification when that Rule is listed or read;
the Design phase of sb-plan evaluates conditional prose against the current Spec. The
default selects design/main for every Spec and selects design/ui only for a
user-visible screen or interaction responsibility.
Every template instruction explicitly names create, maintain, or consume.
Materialization removes create and carries the two durable scopes into the
live artifact. artifact read preserves exact raw artifact bytes, and
steering read preserves exact raw Markdown
by default and accept --for maintain or --for consume to omit the unrelated
durable instruction scope. rule list/read expose the seven fixed project-owned
rule selectors without scanning the directory; rule reads provide the same raw,
maintain, and consume modes and reject live create instructions.
Managed template bodies may define project-owned {{name}} output references.
Every distinct name requires exactly one corresponding
specbind:instruction create output=<name> comment and one or more references.
The agent follows the instruction once and may produce a short string or a
multi-section Markdown fragment, then uses that same output for every reference
to the name. The CLI does not provide built-ins, produce content, or substitute
references. Template discovery rejects missing, duplicate, unused, or Front
Matter output declarations, and live artifact discovery rejects an unresolved
reference. The
default Requirements scaffold deliberately has no dummy live Requirement, and
heading-only Brief, Research, or Implementation Notes artifacts fail live
validation.
Thirteen immutable product protocols and the versioned structured-artifact and
command-input schemas are binary-owned read surfaces exposed by
protocol list/read and schema list/read; they are not installed as project
settings.
Project-level lifecycle artifacts¶
| Artifact or path | Current lifecycle and owner |
|---|---|
{{SPEC_DIR}}/adoption/reverse-discovery.yaml |
Temporary Git-tracked evidence and reconciliation ledger created by the existing-implementation route of sb-discovery, then deleted after every accepted Spec has a complete Brief and Research handoff. |
{{SPEC_DIR}}/deferred.md |
Optional project-wide OKF concept created by the default deferred adapter when the first non-blocking finding is recorded. It is not a gate, fingerprint input, lifecycle artifact, or source of work. |
{{SPEC_DIR}}/steering/roadmap.md |
CLI-owned current active-milestone scope, dependency, baseline, release-binding, and Direct-status record; discovery confirms its authored scope and records complete Source Collection disposition when supplied. |
{{SPEC_DIR}}/steering/<path>.md |
Optional durable SpecBind Steering collection authored by sb-steering and selected by artifact_id. |
{{SPEC_DIR}}/state/contract-review.md |
Current accepted milestone-wide Contract review for a Spec-backed milestone; authored by sb-contract-review and persisted by the CLI. |
{{SPEC_DIR}}/releases/<version>-roadmap.md |
Final released Roadmap archive written by release finalization. |
{{SPEC_DIR}}/releases/<version>-contract-review.md |
Final accepted Contract-review archive for a Spec-backed release. |
Per-Spec artifacts¶
The canonical Spec directory is {{SPEC_DIR}}/specs/<spec>/.
| Artifact | Current lifecycle and owner |
|---|---|
spec.yaml |
Persistent structured lifecycle, active-change, Requirement-selection, gate, and completion state maintained only through guarded CLI operations. |
requirements.md |
Persistent complete current Requirements maintained by the Requirements phase of sb-plan. |
design.md or another SpecBind Design document |
Persistent Design collection maintained by the Design phase of sb-plan; artifact_id is its stable selector. |
contract.yaml |
Persistent strict versioned Contract maintained with Design and reviewed milestone-wide. |
implementation-notes.md or another SpecBind Implementation Notes document |
Optional persistent implementation memory collection. |
brief.md |
Active-milestone input authored by discovery; records the exact relevant Source Items when a collection was supplied and is removed by successful release finalization. |
research.md |
Optional active-milestone gap-analysis result replaced by sb-gap-analysis and removed by finalization. |
tasks.yaml |
Canonical active-milestone task plan and sparse execution state; authored by the Tasks phase of sb-plan, progressed by implementation, and removed by finalization. |
log.md |
Persistent newest-first release history maintained by release finalization for Spec-backed milestones. |
Markdown artifacts are discovered by their OKF type and, for collections, their
artifact_id; the default filenames above are materialization paths rather than
general semantic identity. spec.yaml, contract.yaml, tasks.yaml, roadmap.md, and the
Contract-review state keep their accepted fixed structured paths.
Sources of truth¶
- Installation plan and ownership behavior:
tools/specbind/src/installation/install.rs - Agent removal and project uninstall behavior:
tools/specbind/src/installation/removal.rs - Embedded templates, rules, adapters, protocols, and skills:
tools/specbind/assets/ - Artifact discovery and lifecycle I/O:
tools/specbind/src/artifacts.rs - Structured wire models and generated schemas:
tools/specbind/src/schema/andtools/specbind/schemas/ - Guarded lifecycle mutations:
tools/specbind/src/lifecycle/approval.rs,tools/specbind/src/lifecycle/milestone/,tools/specbind/src/lifecycle/completion/, andtools/specbind/src/lifecycle/release_finalize.rs