Quickstart Guide

Learn how to set up, build, and deploy your OpenKB documentation in under 3 minutes.

WorkflowSTABLE•1 source file

Quickstart Guide

Get up and running with OpenKB using the official CLI.

Installation

Install @todo-labs/openkb globally or use it directly via npx:

pnpm add -g @todo-labs/openkb
npm install -g @todo-labs/openkb
yarn global add @todo-labs/openkb

Step-by-Step Workflow

1

Initialize a new project

Run the init command in your terminal to generate starter files and configuration:

openkb init my-docs
cd my-docs

Start the live preview server

Launch the Astro development server with instant hot-reloading:

openkb dev

Open http://localhost:3000 in your browser to preview your documentation.

Build static export

Generate production-ready static assets in ./dist:

openkb build
Deployment Ready

The generated ./dist folder contains pure static HTML, CSS, JavaScript, and a prebuilt Pagefind search index. You can deploy it to Cloudflare Pages, GitHub Pages, Vercel, Netlify, or AWS S3.