@isdlc/cli

The backbone CLI of the Shefing iSDLC methodology. Scaffolds greenfield projects, walks legacy repos through onboarding, creates plans/ADRs/tech-debt entries, syncs STATE.md, renders graduation reports, and validates the L1 substrate that makes a repo agent-ready (AGENTS.md Rule 4).

See the top-level USER_GUIDE.md for a full step-by-step walkthrough and TOOLING.md for the canonical tooling reference.

Install

npm i -g @isdlc/cli
# or, for a one-shot scaffold:
npx create-isdlc@latest my-project

Commands

| Command | Purpose | |---|---| | isdlc init [name] | Greenfield scaffolder — writes the full L1 substrate from the bundled isdlc snapshot (AGENTS.md, PROCESS.md, SPEC.md, STATE.md, ROADMAP.md, PROJECT.md, TECH_DEBT.md, llms.txt, docs/adr/0000, .isdlc/, generated agent rule files). | | isdlc onboard <path> | Legacy Onboarding walker — advances one Step (0→7) per run, persists progress in .isdlc/onboarding.json, stops at pending-human on every step. Supports --status, --step <id>, --confirm-step <id>, -y/--yes. | | isdlc plan new "<title>" | Scaffold a plan under .isdlc/plans/NNNN-<slug>.md (Objective, Gherkin ACs, DO-NOT list, Context refs). | | isdlc adr new "<title>" | Scaffold an ADR under docs/adr/NNNN-<slug>.md. | | isdlc debt add "<item>" | Append a TD-NNN row to TECH_DEBT.md. Refuses loudly if TECH_DEBT.md is absent (AGENTS.md Rule 6). | | isdlc state sync | Prefill STATE.md from git log + docs/adr/ + active plan. Writes a .bak safety copy and keeps Human confirmation required? Yes unless --confirm is passed. | | isdlc graduate | Render docs/legacy/GRADUATION_REPORT.md from the bundled template after all onboarding steps are confirmed/skipped. --force emits a DRAFT for discussion. | | isdlc doctor | Validate the L1 substrate (drives CI). Exit code: 0 ok, 1 error, 2 warnings only. Supports --json. |

Design invariants

• Methodology .md files are always sourced from the isdlc repo. The CLI ships a pinned snapshot under assets/ produced at build time by scripts/copy-assets.mjs. Users must not hand-fork these files.
• Deliberation-preserving. No command auto-writes plans, auto-approves PRs, or silently flips the Session Continuity confirmation in STATE.md. Commands create skeletons or prefills; the human fills them in and explicitly confirms.
• Methodology guardrails enforced. onboard refuses Step 5 until Step 3 is confirmed; graduate refuses unless every onboarding step is confirmed/skipped (use --force only for DRAFT); debt add refuses if TECH_DEBT.md is missing.
• Version notifier. Each invocation checks the npm registry (24h cache, 2s timeout) and prints a one-line upgrade hint if a newer CLI is published. Opt out with ISDLC_NO_UPDATE_CHECK=1 (also auto-disabled under CI=1).

Dev

npm install                        # from monorepo root
npm -w @isdlc/cli run build
node packages/cli/bin/isdlc.js --help
npm -w @isdlc/cli test             # node --test suite (7 tests)

License

Apache-2.0