Vitest SDK

Docs for Vitest SDK v0.3.3

Living documentation for TypeScript projects. Write executable behavior and technical specifications with Vitest, then publish the results to a browsable, real-time Viewer.

Three Ways to Document Your Code

🧪

BDD Features

Gherkin-style Given / When / Then scenarios for business behavior, acceptance criteria, and stakeholder-readable workflows.

Write your first feature →

📐

Specifications

Concise rules for business policies, APIs, utilities, and data-driven edge cases — readable wherever exact examples matter.

Write your first spec →

🌐

Browser Evidence

Run behavior in a real browser when layout, focus, scrolling, accessibility, or screenshots are part of the contract.

Explore browser testing →

---

Start Here

The Getting Started guide is the single setup path for the Vitest SDK. Choose AI Agent, npm, Yarn, or pnpm there, then create and run your first living specification.

🚀 Get Started with VitestInstall LiveDoc manually or with an AI agent, then run your first documented spec.

---

Explore the Docs

🚀 LearnStep-by-step tutorials from installation to features, specifications, outlines, and value extraction.📖 API ReferenceEvery keyword, context property, data API, reporter, and configuration option documented.🌐 Browser TestingUse Playwright for real layout, focus, interaction, accessibility, and screenshot evidence.💡 GuidesBest practices, Viewer integration, filtering, CI/CD, troubleshooting, and more.