CircuitHub Platform Docs

Install the CLI

curl -fsSL https://circuithub.com/install.sh | bash

Expected output:

Installed circuithub to ~/.local/bin/circuithub
Run `circuithub --help` to get started.

Log in

circuithub auth login

This opens your browser, where you sign in with your CircuitHub account.

Expected output:

Opening your browser to sign in...
If the browser doesn't open, visit:
  https://app.circuithub.com/platform/v1/auth/cli?redirect_uri=http://localhost:52814/cb/6f1c0e9a4b2d8f7365a1c0e94b2d8f73

Signed in as Ada Lovelace (user ID: 1234)
Token expires: 2026-01-02T15:04:05Z

After logging in via circuithub auth login, export the JWT from your credentials file:

export CIRCUITHUB_API_KEY=$(cat ~/.config/circuithub/credentials.json | jq -r '.token')

The token is valid for 24 hours. API key authentication is coming soon for long-lived machine use.

Expected output:

CIRCUITHUB_API_KEY exported for this shell session.

List your workspaces

circuithub workspace list

Expected output:

SLUG              NAME
acme-electronics  Acme Electronics

curl -H "Authorization: Bearer $CIRCUITHUB_API_KEY" \
  https://api.circuithub.com/v1/workspaces

Expected output:

{
  "workspaces": [
    {
      "id": 1,
      "slug": "acme-electronics",
      "name": "Acme Electronics"
    }
  ]
}

List projects

circuithub project list --workspace acme-electronics

Expected output:

ID      REV   NAME
12345   3     Power Supply Board

curl -H "Authorization: Bearer $CIRCUITHUB_API_KEY" \
  "https://api.circuithub.com/v1/projects?workspace=acme-electronics"

Expected output:

{
  "projects": [
    {
      "id": 12345,
      "name": "Power Supply Board",
      "latestRevisionNumber": 3
    }
  ]
}

Get a project's BOM

circuithub project bom list 12345 --workspace acme-electronics

Expected output:

BOM: 4 lines (2 resolved, 1 unresolved, 1 errored)

Part                Footprint    Qty  Match
100nF 0402          C_0402         4  GCM155R71C104KA55D (Murata)

curl -H "Authorization: Bearer $CIRCUITHUB_API_KEY" \
  https://api.circuithub.com/v1/projects/12345/bom

Expected output:

{
  "bomLines": [
    {
      "id": 1001,
      "status": "resolved"
    }
  ],
  "summary": {
    "total": 4,
    "resolved": 2,
    "unresolved": 1,
    "errored": 1
  }
}

Get a quote

circuithub quote request --revision 99001 --quantity 10 --workspace acme-electronics

Output:

Quote:       50001
Revision:    99001 (3)
Quantity:    10
Currency:    USD
Orderable:   yes
Expires:     2026-11-03T11:00:00Z

OFFER   SERVICE   SHIP DATE    MANUFACTURING TOTAL   PER BOARD
880002  priority  2026-11-06   $774.45               $77.45

Manufacturing total excludes shipping and tax.

curl -X POST -H "Authorization: Bearer $CIRCUITHUB_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"revisionId": 99001, "quantity": 10}' \
  https://api.circuithub.com/v1/quotes

Response: 200 OK

{
  "id": 50001,
  "projectId": 12345,
  "revisionId": 99001,
  "revisionNumber": 3,
  "quantity": 10,
  "currency": "USD",
  "createdAt": "2026-11-03T10:00:00Z",
  "expiresAt": "2026-11-03T11:00:00Z",
  "locked": false,
  "status": "ready",
  "type": "assembled",
  "orderable": true,
  "blockers": [],
  "offers": [
    {
      "id": 880002,
      "service": "priority",
      "shipDate": {
        "earliest": "2026-11-06",
        "latest": "2026-11-06"
      },
      "fabricationCountry": "US",
      "assemblyLine": "us_grid",
      "price": {
        "lineItems": [
          {
            "type": "boards",
            "label": "Boards",
            "amount": "504.00"
          },
          {
            "type": "parts",
            "label": "Parts",
            "amount": "279.45"
          },
          {
            "type": "assembly",
            "label": "Assembly",
            "amount": "396.55"
          }
        ],
        "manufacturingSubtotal": "1180.00",
        "discounts": [
          {
            "type": "grid_proto",
            "code": null,
            "label": "Grid Proto",
            "amount": "319.50"
          },
          {
            "type": "account",
            "code": null,
            "label": "Your pricing",
            "amount": "86.05"
          }
        ],
        "manufacturingTotal": "774.45",
        "manufacturingUnitPrice": "77.45",
        "excludes": [
          "shipping",
          "tax"
        ]
      },
      "checkoutUrl": "https://app.circuithub.com/projects/acme-electronics/power-supply-board/revisions/99001/order?quantity=10&offer=880002"
    }
  ],
  "designFeedback": []
}

Review board settings before quoting, and read the quote's designFeedback for changes that would make the design cheaper; see design feedback. To continue through billing, shipping and payment, use the ordering walkthrough.

Quickstart

Install the CLI

Log in

List your workspaces

List projects

Get a project's BOM

Get a quote

On this page