Quickstart

This guide walks you through generating documentation for an existing project. By the end, you'll have a running documentation site with verified code examples, full-text search, and an AI-readable knowledge layer.

Prerequisites

Node.js 18+ (check with node --version)
A Skrypt account at app.skrypt.sh (free tier available)

1. Log in

Terminal

npx skrypt-ai login

This opens app.skrypt.sh in your browser. Sign in to authenticate the CLI. All LLM calls go through Skrypt's proxy, so no third-party API keys are needed.

2. Initialize a docs site

Navigate to your project and initialize:

Terminal

npx skrypt-ai init docs
cd docs && npm install

This scaffolds a Next.js documentation site in the docs/ directory with search, dark mode, syntax highlighting, and 20+ MDX components preconfigured.

3. Generate documentation

Point Skrypt at your source code:

Terminal

npx skrypt-ai generate ../src -o ./content/docs --public-only

Skrypt scans your source files, extracts every exported function, class, type, and API signature, then generates structured documentation with descriptions, parameter tables, and working code examples.

Flag	What it does
`--public-only`	Only document exported/public APIs (skip internals)
`--by-topic`	Organize output by topic instead of file structure
`--multi-lang`	Generate TypeScript + Python examples
`--llms-txt`	Generate `llms.txt` for AI agent discoverability
`--provider anthropic`	Use a specific LLM provider

For best results, use the default provider (Claude Sonnet 4).

4. Preview locally

Terminal

npm run dev

Open http://localhost:3000. You'll see your generated documentation with:

Full-text search (Orama)
Syntax-highlighted code blocks (Shiki)
Dark mode toggle
Table of contents navigation
Responsive sidebar

5. Verify code examples

Terminal

npx skrypt-ai test ./content/docs --verbose

This extracts every code block from your docs, executes them in sandboxed environments, and reports failures. Add --fix to auto-repair broken snippets.

6. Deploy

Deploy to Skrypt hosting (free subdomain included):

Terminal

npx skrypt-ai deploy

Your docs are live at your-project.skrypt.sh.

What's next

Configuration, customize source paths, output format, and LLM settings
Generate Guide, advanced generation options and multi-repo support
Import Guide, migrate from Mintlify, Docusaurus, or other platforms
Testing Guide, verify code examples against your real compiler
Deploy Guide, deploy to Skrypt hosting or your own infrastructure