Quickstart — you just cloned a spec-driven repo#
5 minutes. For a developer joining an existing spec-driven project — not scaffolding a new one. For the full build-from-scratch walkthrough see the tutorial.
0. Prerequisites#
- Node.js ≥ 22.
- Run everything below with
csda(installed vianpx create-spec-driven-appor a global install). All commands auto-detect the project root from your current directory — no--project-dirneeded once you're inside the repo.
git clone <your-repo> && cd <your-repo>
npm install # or your project's setup1. See where the project stands#
csda planLists every requirement and what it still needs — a missing .feature, a
missing test, production code, or just a status update. Pick one to work on.
2. Read the requirement, then work#
Each requirement maps to a Gherkin .feature file (the executable spec) and a
row in docs/specs/traceability.md. Read the feature, write the test first,
then the code until the test passes.
csda req list # readable view of the matrix (no raw markdown)3. Link your work to the requirement — never edit the matrix by hand#
# Point the requirement at the test and code you just wrote
csda req link REQ-007 --feature features/billing/pay.feature \
--test src/test/PayTest.java \
--code src/main/Pay.javaAdding a brand-new requirement? csda req add "<what it does>" appends a
well-formed row and assigns the next REQ-NNN for you.
4. Close the loop#
csda done REQ-007 --check # flips status to Implemented (validates first)5. Validate before you push#
csda validate --strict-tddEvery failure tells you the exact fix. Mechanical problems (an orphan
.feature, a requirement in spec.md with no row) can be auto-repaired:
csda fix --dry-run # see what it would change
csda fix # apply, then re-run validateDaily loop, in one line#
csda plan → work (test first) → csda req link → csda done → csda validate --strict-tddThat's the whole day-to-day. Reach for the how-to guide for specific recipes, or the tutorial to build a project end-to-end.