Ogma Documentation

Source for ogma.kaijinlab.com

---

Documentation for Ogma, the local-first web security testing proxy.

Built with VitePress.

Development

# Install dependencies
pnpm install

# Start local dev server (hot reload)
pnpm dev

# Build for production
pnpm build

# Preview the production build
pnpm preview

The dev server runs at http://localhost:5173 by default.

Structure

.
-- app/           -- Feature documentation (HTTP History, Replay, Automate, etc.)
-- guide/         -- Workflow guides and tutorials
-- reference/     -- Technical reference (HTTPQL, CLI, MCP tools)
-- development/   -- Plugin and extension development
-- plugins/       -- Plugin ecosystem documentation
-- public/        -- Static assets (images, logos)
-- index.md       -- Home page
-- introduction.md
-- getting-started.md
-- .vitepress/    -- VitePress configuration and theme

Contributing

Documentation improvements are welcome.

• Fix a typo or unclear explanation: open a pull request directly
• Add a missing feature page: open an issue first to discuss scope
• Update screenshots: use dark theme at 1440px width

All pages use standard Markdown with VitePress frontmatter. See the VitePress docs for supported extensions.

Deployment

Documentation is deployed automatically to ogma.kaijinlab.com via GitHub Actions on every push to master.

License

Documentation text is licensed under CC BY 4.0. Screenshots and images are copyright Kaijin Lab.

The Ogma application is proprietary software. See the license for details.