@gpcola/devplan-tracker
v1.0.2
Published
Dependency-free DEVPLAN tracker CLI and repository pack for software projects.
Maintainers
Readme
DEVPLAN Tracker
A dependency-free DEVPLAN tracker for any software repository. It keeps a human-readable devplan/DEVPLAN.md and machine-readable devplan/DEVPLAN-STATE.json aligned so humans, CI, and AI agents can see what is planned, blocked, done, and release-critical.
Requirements
- Node.js 18 or newer; Node.js 22 LTS is recommended.
- No runtime dependencies and no external services.
Quick start in this repo
node scripts/devplan.mjs validate
node scripts/devplan.mjs status
node scripts/devplan.mjs next
node scripts/devplan.mjs report --output /tmp/devplan-report.md
node scripts/devplan.mjs readinessThe default layout is:
devplan/
DEVPLAN.md
DEVPLAN-STATE.json
devplan.config.json
docs/
reports/
schemas/Install into another repository
From a checkout of this package:
node install.mjs --target /path/to/repoFrom GitHub once this repository is pushed:
npx github:gpcola/devplan-tracker initAfter npm publication:
npx @1lg/devplan-tracker initThe installer skips existing files unless --force is provided. If the target has a package.json, scripts from package-scripts.json are merged without removing existing scripts. If no package.json exists, the installer prints manual script instructions.
Commands
initinstalls the tracker intodevplan/by default.migratemoves legacy rootDEVPLAN.mdandDEVPLAN-STATE.jsonfiles intodevplan/.statusprints project, branch, status counts, and milestones.validatechecks JSON parsing, schema version, metadata, statuses, unique IDs, milestone references, required item fields, anddevplan/DEVPLAN.mdreferences.nextlists the highest-priority open work.reportemits a Markdown report.readinessexits successfully only when no release-critical items are blocked or open.listfilters tracked items.add-milestone,add-item,update,remove-item,link-item, andprotectmutate state safely.
Installer options
--target <path>installs into another repository.--forceoverwrites existing tracker files and package scripts.--root-filesuses the legacy root-level layout.--local-onlyadds installed tracker files to.gitignorefor local-only use.
Agent rule
Any PR that changes tracked work must update devplan/DEVPLAN-STATE.json in the same PR. Completed work needs evidence and success conditions must remain testable.
More documentation
See devplan/docs/USAGE.md, devplan/docs/GOVERNANCE.md, devplan/docs/AGENT-INSTRUCTIONS.md, devplan/docs/CI.md, and devplan/docs/MIGRATION.md.
