@linkysystems/docd CLI

CLI to install and update DOCD — DOCs-Driven Development, a docs-first development methodology, in any project.

Requirements

• Node.js >= 18

Install

npm install -g @linkysystems/docd

Usage

# Initialize DOCD in the current project
npx docd init --ide kilo

# Install agents/skills globally (~/.agents) instead of in the project;
# .docd.json stays local
npx docd init --ide kilo --global

# Install for multiple IDEs at once (kilo and kimi share the .agents layout)
npx docd init --ide kilo,kimi

# Check installed vs available versions
npx docd status

# List open change plans in the current project
npx docd changes

# Update all DOCD files (uses the global setting recorded in .docd.json)
npx docd update

# Preview changes without applying them
npx docd update --dry-run

# Apply all updates without prompting
npx docd update --yes

# Overwrite local changes without prompting (backups still created)
npx docd update --force

What it installs

• .docd.json — local configuration (including the docs layout under config.docs) and bundle version.
  • config.docs.specFile, guideFile, and uiFile are optional: set any of them to null to disable that file (e.g. projects without UI).
• docs/ — empty directory for feature documentation.
• Provider-specific files (for kilo and kimi, both under the shared .agents/ convention):
  • .agents/agents/docs-manager.md
  • .agents/skills/docs-plan/SKILL.md
  • .agents/skills/docs-implement/SKILL.md
  • .agents/skills/docs-sync/SKILL.md
  • .agents/skills/docs-generate-from-code/SKILL.md

Role-based agents are not included in this package.

Development

npm install
npm run build
npm run dev -- init --ide kilo

This repo dogfoods DOCD: the files under .agents/ are installed copies of src/templates/. After editing any template, run npm run dev -- update --yes to refresh them — tests/dogfood.test.ts fails if they drift.

The project is built with TypeScript and ESM. The entry binary is dist/index.js with a Node shebang.

Copying to a standalone repo

This package is initially developed in tools/docd-cli/ of the current monorepo. To publish it as a standalone repository, copy the entire tools/docd-cli/ folder contents to the root of the new repo and keep the structure flat.

License

MIT