Skrypt Documentation
Skrypt scans your source code and generates beautiful, comprehensive documentation automatically. One command, zero boilerplate.
Info
130 documented API elements across 5 categories — all generated by Skrypt itself.
Core API
Main exports, plugin system, auth, and documentation generation (31 items)
Tools & Utilities
File discovery, frontmatter parsing, validation helpers (7 items)
Types & Interfaces
TypeScript scanner and type definitions (3 items)
Integrations
Anthropic and OpenAI-compatible LLM clients (8 items)
Other
Language scanners, PR analysis, and utilities (81 items)
Quick Start
1
Install
Terminal
npx skrypt-ai generate ./src
2
Configure
Set your API key for AI-powered documentation:
Terminal
skrypt auth login
3
Generate
Skrypt scans your codebase, extracts exports, and generates MDX documentation grouped by topic.
Install Methods
Terminal
npx skrypt-ai generate ./src
Terminal
npm install -g skrypt-ai
skrypt generate ./src
Terminal
brew tap debgotwired/skrypt
brew install skrypt
skrypt generate ./src