Deskribe

Your Codebase Is the Source of Truth. Your Docs Should Reflect It.

Deskribe is an open-source documentation engine that reads your existing code artifacts — router registrations, schema files, migration SQL — and compiles them into a unified, versioned documentation spec. No annotations to write. No portal to maintain manually.

---

Architecture

deskribe/
├── cli/          → Go CLI binary (init, generate, diff, push, serve)
├── portal/       → Next.js cloud portal (dashboard, graph, drift timeline)
├── express/      → Express.js runtime adapter (TypeScript/npm)
├── gin/          → Gin runtime adapter (Go)
└── chi/          → Chi runtime adapter (Go)

How It Works

1. deskribe init — Auto-detects your stack (Gin, Chi, Express, Prisma, sqlc) and writes deskribe.config.json
2. Add one adapter line to your router setup
3. deskribe generate — Produces a unified deskribe.json combining API routes + DB schema
4. deskribe diff — Detects drift against the last committed spec
5. deskribe push — Syncs your spec to the Deskribe portal
6. deskribe serve — Local docs portal at localhost:4040

Quick Start

# Install the CLI
cd cli && go install .

# In your project repository
deskribe init
deskribe generate --cmd "go run main.go"
deskribe serve

Supported Stacks

Layer	Supported
API Frameworks	Express.js, Gin, Chi
Database Schemas	Prisma, golang-migrate (.sql), sqlc
CI/CD	GitHub Actions, GitLab CI (planned)

Project READMEs

Each sub-project has its own README with setup and usage instructions:

• CLI — The core Go binary
• Portal — Next.js cloud dashboard
• Express Adapter — TypeScript runtime adapter
• Gin Adapter — Go runtime adapter for Gin
• Chi Adapter — Go runtime adapter for Chi

License

MIT