weir-toolkit

Scaffold, preview, and ship agent-authored onboarding flows for Weir.

Provides:

• the weir CLI — weir init, weir app-doctor, weir conform, weir dev, weir walk, weir release, and every other Weir tool as a subcommand
• an MCP server (weir-toolkit/server via npx) so a coding-agent host (Claude Code, Cursor, etc.) can call the same tools directly

Dashboard included. weir dashboard starts a local API and the dashboard UI in one command — no repo checkout, no pnpm, no extra env vars. See "Dashboard" below.

Install

npm install -g weir-toolkit
weir init

Or run without installing:

npx weir-toolkit init

Quickstart

Every command below is literally runnable, in order, from an empty directory — copy/paste it. weir init picks a placeholder appId from the directory name if you don't pass --appId; it prints what it chose and how to override it.

mkdir my-app && cd my-app
weir init                                                # scaffold weir/app.json + a starter v4 config.json baseline, zero network
weir app-doctor                                          # validate the native app/config contract
weir release --flowId onboarding --dryRun                # run the release gate locally; never calls the API
weir dev --specPath weir/flows/onboarding.json --serve   # optional browser QA only, not native embedding validation

Then, to see the flow-spec authoring vocabulary instead of learning it one rejected key at a time:

weir schema                 # every screen type: required/optional fields + a minimal example
weir schema singleSelect     # just one screen type

Run weir list (or weir --help) to see every subcommand with its full description.

MCP server mode

Register it in an agent host's MCP config, e.g. for Claude Code / Cursor:

{
  "mcpServers": {
    "weir": {
      "command": "npx",
      "args": ["-y", "weir-toolkit@latest", "weir-mcp"]
    }
  }
}

See docs/toolkit-install-public.md in the weir repo for the full install guide.

Dashboard

weir dashboard

Starts a local @x/api instance (dev mode — no signing key, no Firebase, no account) and serves the prebuilt dashboard UI, both from this same package — no repo checkout, no pnpm, no Vite. It prints the URL to open and signs you in automatically (dev mode accepts any bearer token, so there's no "Advanced: sign in with a bearer token" step to do by hand). Press Ctrl-C to stop both servers.

Requires Node.js 22+ (the local API uses the built-in node:sqlite module, unflagged only from Node 22). Every other weir command works on Node 18+; weir dashboard checks the runtime itself and prints a clear message instead of a stack trace if it's too old.

By default the API binds port 8787 and the dashboard a nearby free port, printed on start; if 8787 is already in use (e.g. another local API already running), it picks a free port instead of crashing and says so.

See docs/mcp-toolkit.md ("Local dev") for more on the underlying API/ dashboard split, and how to publish real flows to it with weir release.

License

MIT