# specfold

> specfold keeps design, plan, and maintenance docs next to your code, linked as a graph and guarded by checks.

specfold is a Rust command-line tool, `spec`. Every page below has its Markdown source at `<page>/index.md`. All of them in one file: [llms-full.txt](https://specfold.build/llms-full.txt).

## Docs

- [Tutorial: three steps](https://specfold.build/start/index.md): Write a first document, link it to code and check it, in three steps.
- [Install](https://specfold.build/start/install/index.md): Install spec with npm, cargo or a prebuilt binary, and verify the download.
- [Concepts](https://specfold.build/concepts/index.md): The ideas behind specfold, one page each.
- [Document types](https://specfold.build/concepts/document-types/index.md): The eleven built-in document types and what each one is for.
- [Lifecycle](https://specfold.build/concepts/lifecycle/index.md): Document statuses, allowed transitions and how spec enforces them.
- [Owners and ids](https://specfold.build/concepts/owners-ids/index.md): Owners decide where documents live; ids are computed from that place.
- [The graph](https://specfold.build/concepts/graph/index.md): Relations between documents and code, and the commands that query them.
- [Checks](https://specfold.build/concepts/checks/index.md): Rules, guards, plugins and audits, and how each one reports.
- [Times and tasks](https://specfold.build/concepts/times-relations/index.md): How specfold writes and reads times, and how task items are counted.
- [Using with AI agents](https://specfold.build/guides/agents/index.md): Instruction lines, MCP, JSON output and agent assets.
- [Checks in CI and hooks](https://specfold.build/guides/ci/index.md): Run spec check before each commit and in continuous integration.
- [Importing an existing layout](https://specfold.build/guides/import/index.md): Bring documents in from another layout through an import map.
- [Editing documents](https://specfold.build/guides/editing/index.md): Create, change, edit and move documents from the command line.
- [Attachments](https://specfold.build/guides/attachments/index.md): Files that belong to a document, in the repository or an external store.
- [Commands](https://specfold.build/reference/commands/index.md): Every spec command, grouped by what it does, generated from the CLI.
- [Rules](https://specfold.build/reference/rules/index.md): Every rule spec check runs, grouped by family.
- [Configuration](https://specfold.build/reference/config/index.md): The spec.toml tables and what each one controls.
- [FAQ](https://specfold.build/faq/index.md): Short answers to common questions about specfold.
- [Changelog](https://specfold.build/changelog/index.md): Where to find what changed in each specfold release.

## Optional

- [Source code](https://github.com/modootoday/specfold)