Skip to content
imugi imugi

Installation

Requirements

  • Node.js >= 18
  • Chromium (installed automatically by imugi init)

Install

Terminal window
npm install -g imugi-ai

One-Click Setup

Run the init command to auto-detect your project, install Playwright’s Chromium browser, and create a default config:

Terminal window
imugi init

This will:

  1. Detect your framework (React, Vue, Svelte, etc.)
  2. Detect your CSS method (Tailwind, CSS Modules, etc.)
  3. Install Playwright Chromium for screenshot capture
  4. Create imugi.config.json with sensible defaults

Authentication

MCP Mode (No API key needed)

When used as an MCP server with Claude Code or Cursor, no API key is required. imugi provides visual tools (capture, compare, heatmap) while your AI editor handles the reasoning and code generation. Zero additional cost.

CLI / Agent Mode

For standalone usage, imugi needs Claude API access for code generation and vision analysis:

Option A: API Key

Terminal window
export ANTHROPIC_API_KEY=sk-ant-...

Option B: OAuth (Interactive Agent only)

Terminal window
imugi auth login

This opens a browser for OAuth authentication. Tokens are stored securely at ~/.imugi/auth.json with restricted permissions.

Verify Installation

Terminal window
imugi --version
imugi --help

Next: Quick Start