1.0 KiB
1.0 KiB
| description |
|---|
| Set up the ADR system (docs/adr/ + generated index) in a project that has none, and clear any session-reminder suppression. Invoked by `/os-adr:init`. |
Initialize the standard ADR layout in the current project. Everything is mechanical — run the CLI, don't create the files yourself:
ruby ${CLAUDE_PLUGIN_ROOT}/bin/adr-init --root <project-root>
This creates docs/adr/ with a generated README.md index (empty table between markers,
regenerated in full on every ADR write — never hand-edited), and deletes .os-adr/suppress if
present so the SessionStart reminder resumes normal behavior.
It is idempotent: safe to run in a project that already has ADRs (the index is regenerated from the directory contents).
Afterwards:
- Ensure
.os-adr/is gitignored (append to.gitignoreif the project has one and the entry is missing). - If the project has existing ADR-like content in another shape, suggest
/os-adr:migrateinstead of re-authoring. - Offer
/os-adr:createto record the first decision.