Skip to main content

Generate and maintain a complete documentation context layer for any repo — using the LLM already in your IDE.

Project description

Doctyze

Generate and maintain a complete documentation context layer for any repo — using the LLM already in your IDE.

License: Apache 2.0 AGENTS.md Status


What it does

Point Doctyze at any existing repository, any tech stack. It:

  1. Consolidates scattered docs (loose READMEs, wiki notes, stray design files) into one canonical docs/ structure — non-destructively.
  2. Bootstraps the full SDLC context layer from the code: specs, architecture docs + Mermaid diagrams, dev/testing skills, runbooks, deployment & observability docs.
  3. Maintains it — when code changes, it flags the docs that are now stale and your agent refreshes them.

The result serves both humans and AI coding agents (AGENTS.md, .cursor/rules, Claude Code skills, MCP).

Bring your own agent (no API key)

Doctyze does not call an LLM or need an API key. It brings the playbook (skills) and the deterministic mechanics (consolidation, drift detection, fan-out); the LLM is the one already in your IDE (Cursor / Claude Code / Copilot) or your CI agent. In your editor you just run the Doctyze skill and your existing agent does the generation.

Commands

doctyze init                    # guided front door: scaffold + install skills + next steps
doctyze consolidate [--apply]   # scattered docs -> canonical docs/ (propose, then apply)
doctyze bootstrap               # scaffold structure + hand a generation manifest to your agent
doctyze index                   # build docs/ navigation (table of contents) for humans + agents
doctyze distribute              # fan skills out to .claude/skills, .cursor/rules, AGENTS.md
doctyze watch [--install]       # flag docs whose anchored code changed (warn-first pre-commit hook)

Your agent runs the generation (the doctyze skill chains all of the above); the CLI handles the deterministic mechanics. Generated docs land in a canonical docs/ tree — specs/, architecture/{diagrams,decisions}/, runbooks/, observability/, guides/, skills/ — with a docs/index.md table of contents.

Generated docs carry a freshness anchor declaring which code makes them stale:

---
doctyze:
  artifact: spec
  generated_by: write-spec
  affects: [src/payments/**]
  last_verified: 2026-06-15
---

Status

v3 is a ground-up rewrite (the v2 skills-first design is superseded; in git history). The engine — consolidate, bootstrap, distribute, watch — is built and tested (pytest), and validated end-to-end on a real service repo. The distribution/release step (PyPI package, Claude Code plugin, CI action) is in progress; until then, run from source:

pip install -e .
doctyze --help

See docs/planning/DOCTYZE_V3_PLAN.md, docs/planning/DOCTYZE_V3_BUILD_PLAN.md, and docs/architecture/decisions/0003-pivot-to-context-layer-generator.md.

License

Apache 2.0. Free and open source for everyone.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

doctyze-0.3.0.tar.gz (38.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

doctyze-0.3.0-py3-none-any.whl (40.9 kB view details)

Uploaded Python 3

File details

Details for the file doctyze-0.3.0.tar.gz.

File metadata

  • Download URL: doctyze-0.3.0.tar.gz
  • Upload date:
  • Size: 38.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for doctyze-0.3.0.tar.gz
Algorithm Hash digest
SHA256 a989fed578ae58027b219f07173f5b8258af3913d0e72864cbd09400963a1e13
MD5 be61d0d5d47140dfa036af6754735584
BLAKE2b-256 e5f85997ce5a42b8d3775d313fe0aab7f7a57491863d252e33db96d38f62e7a6

See more details on using hashes here.

Provenance

The following attestation bundles were made for doctyze-0.3.0.tar.gz:

Publisher: release.yml on actyze/doctyze

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file doctyze-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: doctyze-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 40.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for doctyze-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cda1a140744a88d2b2fb93a3a0510724af4fed6f89aee04e2d3db55853663a1c
MD5 503b47b50ef4fbfe8b734ca692feeeea
BLAKE2b-256 a9f1c8e521d642a86665e0cfc821fa8b933b117c95b0f730b9ad73739f8a4e65

See more details on using hashes here.

Provenance

The following attestation bundles were made for doctyze-0.3.0-py3-none-any.whl:

Publisher: release.yml on actyze/doctyze

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page