Expand description
The spec-format seam: everything the runtime knows about
a spec format comes from an Adapter — where the intent lives, what a
planning skill may write, what the model is told, how a task is ticked.
The judge (verification, evidence, commits) is the same for every format.
Spec Kit is the reference format; OpenSpec runs too. Kiro is detected, so a project in it gets a clear answer instead of “not a project”.
Modules§
- openspec
- OpenSpec: a change in
openspec/changes/<id>/is the unit of work, its spec deltas’ scenarios are the acceptance examples, itstasks.mdis a chain. Parsing and preflight are thespeccoder-openspeccrate’s; this adapter is the only runtime code that knows OpenSpec. - speckit
- GitHub Spec Kit, the reference format:
.specify/andspecs/NNN-name/withspec.md,plan.mdandtasks.md. Parsing is thespeccoder-speckitcrate’s; this adapter is the only runtime code that knows Spec Kit’s paths and words.
Structs§
- Assess
- The format’s words in the convergence assessment.
- BugRefusal
- Why a bug cannot be recorded or read here.
- BugStep
- How a format’s own bug step is run: the hosted skill, its arguments and what it may write.
- Commit
Precondition - What a worktree needs committed: a worktree contains only commits.
- Extension
- An installed extension of the format, as its inventory lists it.
- Format
Init - What a new project asks of the format’s own init (spec 101).
- Init
Step - One command of the format’s own init, as a new project’s plan runs it.
- Inventory
- The format’s installed extensions.
- Messages
- What a person is told; texts name the format’s own files and commands.
- Opened
- The project’s format, resolved and opened.
- Oracle
Requirement - A requirement a review writes tests for: the format’s
requirement (
US1) with the scenario ids its tests cite (US1-1). - Plan
Structure - A unit’s plan structure: phases and stories. Formats without that structure have none.
- Planned
Task - One task as the plan checks read it.
- Planning
- Hosted planning skills.
- ReadBug
- The triad as a format’s own bug file holds it.
- Recorded
- Where a quick change was recorded.
- Recorded
Bug - A bug the adapter recorded in a standing unit.
- Refused
- Why no project was opened.
- Rules
- Which paths are the format’s intent, and what a hosted planning skill may touch.
- Wording
- Model-facing fragments; the prompts around them are the same for every format.
- Workspace
- A project root that all reads are confined to.
Enums§
- Inventory
Source - Which source the inventory was read from.
- Phase
Kind - What kind of phase a task sits in, as the format’s structure says.
Traits§
- Adapter
- One spec format the runtime can run.
- Detect
- What every known format implements: finding its marker.
Functions§
- adapter
- The adapter of
kind, if this build runs it. - adapters
- Every adapter this build runs, in detection order.
- at
- The adapter of a project already opened at
root(a worktree’s project, a snapshot’s root): resolved the wayopenresolved it, the reference format where nothing decides. - bug_
refusal_ unsupported - Why a project in a format this build detects but does not run has no
place for a bug (
BUG-NO-UNIT), if it is one. - code_
spans - The code spans of a text (between single backticks).
- no_
found_ env - No variables found.
- of
- The adapter of an inspected project.
- open
- Opens the project containing
startin the requested, configured or detected format. - open_
with openwith an explicit choice instead of the process-wide request.- parse_
config [spec] formatfrom aspeccoder.toml’s text.- reference
- The reference format, the default where no project decides.
- request
--format/SPECCODER_FORMAT: chosen once, by the binary, before any command runs.
Type Aliases§
- Command
Rule - A format’s ruling on a command (
argv, whether a planning skill asks):Some(Ok)allowed,Some(Err(why))refused,Noneno opinion. - Found
Env Rules::found_env: the variables, given a lookup of the command’s environment.