Documentation

Get from zero to your first generated component in five minutes.

Install

Install the Pixicode CLI globally. It works on macOS, Linux and Windows (WSL).

npm install -g @pixicode/cli
pixi --version
# pixi 2.4.1

Authenticate

Sign in with your Pixicode account. The CLI will open a browser window and store a refresh token locally.

pixi auth login
# ✓ Authenticated as mara@northwind.com (workspace: northwind)

Your first run

Point Pixicode at a Figma file and your design system package. The first run takes about 90 seconds while we infer your library.

pixi init \
  --figma https://figma.com/file/abc123 \
  --system @northwind/ui \
  --framework react

pixi generate components/PricingCard
# → opened PR #2918 (97.8% confidence)

Agents

Pixicode runs a fleet of four specialist agents: planner, executor, verifier and writer. Each agent has a narrow contract, an explicit budget, and an independent model. You can inspect their decisions in the trace viewer at app.pixicode.com/trace/<run-id>.

Tokens

Pixicode treats W3C Design Tokens as first-class citizens. We read tokens from your Figma file, your code repository, or a standalone tokens.json. The planner reconciles all three and flags drift.

Workflows

A workflow is a declarative graph of agent steps. Define one with TypeScript:

import { defineWorkflow } from '@pixicode/sdk'

export default defineWorkflow({
  name: 'brand-migration',
  steps: [
    { agent: 'planner',  input: 'figma_file' },
    { agent: 'executor', tools: ['github', 'storybook'] },
    { agent: 'verifier', evals: ['a11y', 'visual-diff'] },
    { agent: 'writer',   output: 'pull_request' }
  ]
})

Evals

Pixicode ships an eval harness with the SDK. Run regression tests on your own data before promoting a workflow to production.

pixi eval run \
  --workflow brand-migration \
  --dataset ./evals/golden.json

CLI reference

See API reference for the complete command list, flags and exit codes.