Command line

Run workflows from your terminal.

Install the Patchr CLI and run Hunt, Resolve, Proxy, and Pay workflows without writing application code.

Install the CLIGet an API key

Step 1

Install

Choose your preferred package manager. Python 3.11+ and Node.js 20+ are both supported. The CLI is identical across both paths.

Python (pip)
pip install patchr
Node.js (npm)
npm install -g @patchr-core/cli

Step 2

Authenticate

Set your API token as an environment variable. Get your token from the dashboard at patchr.co/dashboard.

Shell env vars
export PATCHR_API_TOKEN="your-token-here"
export PATCHR_API_BASE_URL="https://api.patchr.co"

Step 3

Run a workflow

Every Patchr workflow is accessible via patchr run. Pass the workflow name and a natural-language task — the CLI handles the rest and returns a proof card on completion.

Run a resolve workflow

patchr run --workflow resolve --claim "Disputed invoice from vendor X"

Run a hunt workflow

patchr run --workflow hunt --request "Find suppliers for industrial components under $10k"

Run with a proxy handoff enabled

patchr run --workflow proxy --task "Contact delivery provider for order #8821"

Export a proof pack

patchr proof export --pack-id pack_abc123 --format json

Example output

Every run ends with a proof card.

The CLI returns a structured proof card on stdout. Pipe it to a file, post it to a webhook, or cite the proofPackId in your own systems.

JSON output (truncated)
{
  "status": "resolved",
  "proofCard": {
    "kind": "resolveOutcome",
    "title": "Disputed invoice from vendor X",
    "cite": "patchr:proofCard:card_inv_x_001#v1",
    "confidence": 0.91,
    "evidenceStatus": "sufficient",
    "recommendedRestraint": "approve",
    "escalation": {
      "recommended": false
    },
    "openQuestions": [],
    "summary": "Invoice matched against three independent delivery receipts.
Confidence 91%. Recommend approve without escalation."
  },
  "proofPackId": "pack_inv_x_001",
  "runId": "run_7k2mq9x",
  "completedAt": "2026-05-26T14:32:01Z"
}

Ready to build?

Start running workflows in minutes.

Get your API key, install the CLI, and run your first Patchr workflow — Hunt, Resolve, Proxy, or Pay — from a single terminal command.

Get API key Read API reference