Getting Started

Install Dokkimi and run your first test in minutes.

Prerequisites

You need two things on your machine:

• Node.js 20+
• Docker — Docker Desktop is the easiest path. Any Docker-compatible runtime works.

Install

On macOS with Homebrew:

brew install dokkimi/tap/dokkimi

Or via npm (any platform, requires Node.js 20+):

npm install -g dokkimi

Verify your environment is ready:

dokkimi doctor

dokkimi doctor checks that Docker is running and your environment has enough resources. Fix anything it flags before continuing.

Scaffold example definitions

dokkimi init

This creates a .dokkimi/ folder with an example topology — a simple API gateway, a backend service, and a Postgres database. See Project Structure for details on how this folder is organized.

Run your first test

dokkimi run

Dokkimi will:

1. Create an isolated Docker environment
2. Deploy your services with interceptor sidecars
3. Seed any databases
4. Attach a Chromium browser (if your test includes UI actions)
5. Wait for readiness checks to pass
6. Execute your test steps — HTTP requests, database queries, and browser interactions
7. Report results, diff screenshots against baselines, and tear everything down

You'll see real-time output as each step executes and assertions pass or fail.

Inspect results

dokkimi inspect

Opens a full-screen interactive TUI showing every HTTP call the interceptor captured, assertion results, console logs, and database queries from the last run. See the CLI Reference for all available commands.

Next steps

• Project Structure — understand the .dokkimi/ folder layout
• Services — define your own services
• Databases — add Postgres, MySQL, MongoDB, or Redis
• Mocks — intercept calls to external APIs
• Tests & Steps — write test cases
• Actions — HTTP requests, database queries, and UI interactions (including visual regression with screenshots)