Getting Started

Start using KaizenAI

A complete guide to installing, configuring, and running KaizenAI for your projects.

[Screenshot Placeholder: KaizenAI Workspace Browser Interface]

Requirements

Before you begin, ensure you have the following installed:

  • Bun: Bun (v1.3.5 or higher) - Required to run Kaizen.
  • AI Provider: At least one AI provider (e.g., Claude Code, Codex, or Gemini) installed locally.

Installation

Quickstart

You can run Kaizen directly without installing:

Terminal
npx kaizenai

Global Installation

For easier access, install Kaizen globally:

Terminal
npm install -g kaizenai
kaizen

Running Kaizen

Once installed, you can start Kaizen from your terminal in any project directory.

Start with default settings (port 3210):
kaizen
Start on a custom port:
kaizen --port 4000
Bind to a specific host:
kaizen --host dev-box
Share to your other Tailscale devices with a QR handoff:
kaizen --remote
Start without automatically opening the browser:
kaizen --no-open
[Screenshot Placeholder: Terminal startup showing local URL, Tailscale URL, and QR handoff]

Remote Access With Tailscale

Use `kaizen --remote` as the default remote workflow. Kaizen prints a stable Tailscale URL and a QR code that opens the handoff page on your other device.

  1. Install Tailscale on your development machine and your remote device.
    Download Tailscale →
  2. Start Kaizen with the remote flag and scan the QR code it prints:
    Terminal
    kaizen --remote
  3. Kaizen opens the installed app when the platform supports it, otherwise it falls back to the browser with install guidance.
[Screenshot Placeholder: scanning Kaizen QR handoff and opening the app]

Ready to build with confidence?

Start with proven patterns and let AI help you scale faster.

Get started nowBack to home