docki-cli
v0.1.0
Published
Docki — architecture knowledge for Cursor and VS Code. Analyze any repo into a persistent /knowledge base, then explore it.
Maintainers
Readme
Docki
Architecture knowledge for Cursor and VS Code.
Docki analyzes a repository, writes a persistent evidence-based knowledge base under /knowledge, and ships an Explorer so your team can browse, search, and follow evidence links — including Mermaid diagrams.
npx docki-cli init
# then in Cursor: docki-knowledgeWhat you get
| Piece | Purpose |
|-------|---------|
| docki-knowledge skill | Full architecture analysis → /knowledge |
| docki-update skill | Incremental refresh after code changes |
| 5 specialist agents | System, domain, integration, data, infrastructure |
| Cursor rule | Reminds agents to read /knowledge on cross-cutting work |
| Docki Explorer | VS Code / Cursor extension: tree, search, Mermaid, evidence links |
Install into a repository
Prerequisites
- Node.js 18+
- Cursor (for skills) and/or VS Code (for Explorer)
One command
From the repository you want to document:
npx docki-cli initOr from a local Docki checkout:
node path/to/docki/packages/cli/bin/docki.js init --target /path/to/your-repoOptions:
docki init --force # overwrite existing Docki kit files
docki init --dry-run # show what would be written
docki init --with-explorer # also build & install Docki Explorer
docki doctor # verify kit files
docki install-explorer # build .vsix and install into Cursor/VS CodeAfter init
- Open the repo in Cursor
- Invoke the skill
docki-knowledge(no custom prompt required) - Optionally install the Explorer:
npx docki-cli install-explorer - After meaningful code changes, invoke
docki-update
Knowledge classifications
Every meaningful claim is labeled:
- DECLARED — explicitly documented/configured
- OBSERVED — directly evidenced in the repo
- INFERRED — supported by evidence (with confidence)
- UNKNOWN — not determinable
Source code always wins over generated docs. Secrets must never be copied into /knowledge.
Repository layout (this product)
docki/
kit/ # files copied by `docki init`
.cursor/skills/
.cursor/agents/
.cursor/rules/
AGENTS.md
MODEL-RECOMMENDATIONS.md
packages/
cli/ # `docki` command
explorer/ # Docki Explorer extension
templates/knowledge/ # empty scaffold
docs/ # full documentationDocumentation
- Getting started
- How Docki works
- CLI reference
- Docki Explorer
- Contributing
- Publishing to GitHub / npm
- Spec Kit artifacts (Explorer design)
Safety
Analysis is read-focused. Docki skills must not modify application source — only /knowledge (and the kit files you install).
License
MIT — see LICENSE.
