← Docs

Quickstart — 5 minutes to first audit

Goal: see /inkpal:audit return findings on a real project. Zero handholding. If anything in this page takes more than the time budget, file an issue.

1

Get a key

60s

From your terminal:

npx inkpal trial your@email.com

You'll see ink_trial_… printed and the same key sent to your inbox. One trial per email, expires in 24 hours, no card.

2

Wire it into your editor

60s

Pick the auto-install command for your IDE:

npx inkpal claude install --key <your_key> # or: cursor / windsurf / codex / copilot

Restart the editor. See /docs/install for hand-edit configs and per-IDE notes.

3

Open a Flutter project

60s

cd into any Flutter project (or scaffold one):

cd /path/to/your/flutter/project # or: flutter create my_app && cd my_app

Open the project in your editor. The MCP server boots automatically — you should see[inkpal] License OK — Pro active (or Trial active) in stderr.

4

Run the smoke test

180s

In your editor chat, type:

/inkpal:audit

The response should look like this:

{
  "source": "railway:engine(8/8)",
  "rules_run": 101,
  "engine": {
    "packs_loaded": ["audit_ui", "architecture", "layout", ...],
    "context_summary": "state: riverpod | nav: go_router | platforms: ios/android"
  },
  "findings_count": 12,
  ...
}

If you see the engine block with packs_loaded, the install is good. The findings depend on your code.

✓ You're done

That's the 5-minute gate. From here, the natural next moves:

  • /inkpal:debug — reproduce + fix a runtime error
  • /inkpal:build "<your spec>" — generate a screen from a sentence
  • /inkpal:test — run tests with quality scan
  • /inkpal:ship — pre-merge gate + auto-PR

Trial expires in 24h. Subscribe when you're convinced.

If something didn't work

  • Editor doesn't see InkPal MCP → run npx inkpal status + npx inkpal upgrade.
  • Audit returns starter rules only (3 of them)INKPAL_LICENSE_KEY not loaded into editor MCP env. Re-run install with --key.
  • Trial endpoint hangs → corporate firewall. See troubleshooting.
  • Anything elseGet help.