← Docs

Install InkPal

Three steps. Five minutes. Works in 5 IDEs.

1. Get a 24-hour trial key

Email-only. No card. The key arrives in your inbox + the terminal output.

npx inkpal trial your@email.com

Already have a key? Skip to step 2.

2. Wire InkPal into your editor

Pick your IDE. Either run the auto-install command, or hand-edit the config.

Auto-install (recommended)

npx inkpal claude install --key ink_your_key_here

Replaces or merges into your existing MCP config. Preserves other servers.

Or, hand-edit

Open ~/.claude.json and paste:

{
  "mcpServers": {
    "inkpal": {
      "command": "npx",
      "args": ["-y", "-p", "inkpal@latest", "inkpal-mcp"],
      "env": { "INKPAL_LICENSE_KEY": "ink_your_key_here" }
    }
  }
}

Restart Claude Code to activate.

3. Run on your Flutter project

cd /path/to/your/flutter/project
export INKPAL_LICENSE_KEY=ink_your_key_here
npx inkpal start

inkpal start patches pubspec.yaml + main.dart AST-safely (idempotent). On success, you'll see a structured doctor report and a first-success loop.

Verify it's working

In your editor, run:

/inkpal:audit

The response should include an engine block with packs_loaded. That's the smoke test — you're good.

Troubleshooting

  • Editor shows "inkpal: failed" → run npx inkpal upgrade. Scrubs stale install artifacts.
  • License rejected → trial expired. Subscribe or use a different email.
  • Engine block missing → check Railway is reachable: /status. Or run npx inkpal doctor.
  • Anything elseGet help.