DIXI Spec Kit documentation Español · Source on GitHub

/dixi.onboard

Purpose

Bring an existing codebase under DIXI: draft modules, features and traceability from the code.

Adopt an existing project: read the code in the roots named in $ARGUMENTS and propose domains, modules and features as drafts the person validates, with evidence for every claim. Documentation only; the code does not change.

Generated by scripts/build-command-reference.py from the packaged command text; do not edit by hand.

Invocation

Argument: [code roots to read, for example src/ app/]. Angle brackets mark a required value and square brackets an optional one. In the steps, $ARGUMENTS is the text written after the command.

Example

The text after the command is the request; change it to match your project.

When to use it

Steps

  1. Read 00-governance/principles.md, 00-master-spec.md, .dixi/traceability.json, the README, the build or package manifests and the tests. Map the code roots, entry points (routes, commands, handlers, jobs), data stores and external integrations, citing file:line for each.
  2. Propose a split into domains and modules, and the features each module exposes, as a table with the evidence behind each line. Mark uncertain boundaries. Stop here and ask the person to validate or correct the split; do not write specs before that answer.
  3. After validation, write one draft per module in 04-modules/<module>/module-spec.md and per feature in 05-features/<slug>/feature-spec.md, each starting with Status: draft (onboarded from code). Describe observable behaviour with file:line evidence; write acceptance criteria only for behaviour the code or its tests show, and {{pending: …}} for intent, rules and anything the code cannot prove.
  4. Register the new domains, modules and features in .dixi/traceability.json with their parents. Do not register tests as covering a criterion unless the test asserts it.
  5. Keep existing specs and IDs; never overwrite a document the person wrote. Report conflicts instead.
  6. Suggest /dixi.constitution if no principles exist, /dixi.clarify for the pending intent, and /dixi.converge per feature to turn the gaps into tasks.

Files read and written

Paths named by the command text:

Stops and human gates

Closing

Run dixi check before finishing and report: files touched, modules and features drafted, pending markers left, checks (run, failed, not run), open items and the suggested next command.

Next step