The engineto document
Scribe analyzes your TypeScript codebase with AST parsing and git history, then generates polished markdown docs using the LLM of your choice. No manual writing, no stale docs.
From source to docs.
Automatically.
AST source analysis
Parses your source code with ts-morph — walking the syntax tree to extract functions, classes, interfaces, types, enums and JSDoc so docs reflect your real code.
Git history aware
Reads your git graph with simple-git, parsing conventional commits, tags and branches to build versioned changelogs automatically.
Pluggable AI connectors
Snap in any of 7 providers — Anthropic, OpenAI, Google, Groq, Mistral, xAI and AWS Bedrock. Swap models like connectors: cheap for drafts, premium for the final pass.
Four document types
Generates README, API reference, versioned CHANGELOG and ARCHITECTURE guide — emitted as markdown or fumadocs-ready MDX to ./docs.
Context routing & token efficiency
Sends only the required AST or Git context depending on the document type. API refs get pure AST, changelogs use git history, READMEs use summaries, and guides combine both—minimizing token waste with smart routing and model tiering.
Three commands.
Always up-to-date docs.
1$ npx @scribe-docs/cli init2┌ Scribe - Documentation Generator3│4◆ Which AI provider do you want to use?5│ ● Anthropic (Claude models)6│ ○ OpenAI (GPT models)7│ ○ Google (Gemini models)8│ ○ Groq (fast · free tier)9│ ○ Mistral · xAI · Bedrock10│ ↑/↓ navigate Enter confirm11└
Four clean
layers.
Scribe is built as four decoupled layers. Static analysis stays free of AI dependencies, generation is fully pluggable, and the SDK orchestrates the whole pipeline behind a simple CLI.
Less config.
More docs.
Bring your own LLM.
Use what you know.
7 AI providers, all pluggable via optional peer deps — powered by best-in-class open source tooling, with markdown and fumadocs-ready MDX output.
Docs that keep
themselves honest.
Scribe documents itself. Use cheap models for drafts and premium ones for the final pass, run it in GitHub Actions, and point it at any package in your monorepo with a single flag.
Always up-to-date
Docs regenerate from your actual source code and git history — never stale, never out of sync.
No DSL to learn
Just your TypeScript code and conventional commits. Nothing else to maintain.
Config-as-code
scribe.config.ts/.js/.mjs loaded at runtime via jiti — TypeScript imports, env vars, full flexibility.
Changelog versioning
CHANGELOG_001.md, CHANGELOG_002.md — Scribe increments and never overwrites your history.
Built by devs.
For devs.
Config-as-code, sensible defaults, and CLI flags that override config which overrides env vars. Drop Scribe into any TypeScript project and run it in CI.
TypeScript native
Parses real source with ts-morph.
Interactive init
Pick provider, model, key and docs.
Env var detection
Reads ANTHROPIC_API_KEY, OPENAI_API_KEY, etc.
Markdown or MDX
Plain markdown or fumadocs-ready MDX.
npx @scribe-docs/cli init -ynpm install @ai-sdk/anthropicexport ANTHROPIC_API_KEY=********npx @scribe-docs/cli generate
"Scribe replaced a week of manual doc writing with a single command. Our README is finally never out of date."
Sarah Chen
Staff Engineer
0 hours writing docs
Free and
open source.
Scribe is free forever. You only ever pay your own LLM provider for the tokens you use. No seats, no tiers, no surprises.
Open Source
For individuals, teams and OSS projects
MIT licensed
- Full CLI, free forever
- All 4 document types (README, API, CHANGELOG, GUIDE)
- All 7 AI providers
- Config-as-code (scribe.config.ts)
- Monorepo support with --dir
- Git-history-aware changelogs
- fumadocs-compatible MDX output
- Bring your own API key
The Scribe CLI is open source and free to use with your own API keys. View the source
Ready to stop
writing docs?
Point Scribe at your TypeScript project and generate polished markdown docs in one command. Open source, bring your own LLM.
npx @scribe-docs/cli generate