Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.iblueprint.ai/llms.txt

Use this file to discover all available pages before exploring further.

The iBlueprint CLI exposes four commands that cover the core blueprint workflow: discovering blueprints, inspecting their configuration, running them with inputs, and tracking the resulting execution. All commands communicate with the iBlueprint API over tRPC, and all require the IBP_API_URL environment variable to be set.

​
iblueprint list

Lists all blueprints your account can access, rendered as a table in your terminal. Usage 
iblueprint list
Example output 
┌────────────────────────────────────┬─────────────────────────┬──────────┐
│ id                                 │ name                    │ status   │
├────────────────────────────────────┼─────────────────────────┼──────────┤
│ 3f2a1b4c-…                         │ Customer Onboarding Flow│ active   │
│ 9e8d7c6b-…                         │ Support Triage          │ draft    │
└────────────────────────────────────┴─────────────────────────┴──────────┘
The table displays each blueprint’s id, name (title), and status. Copy an id value to use with the get or execute commands.

​
iblueprint get <id>

Fetches the full details of a single blueprint and prints them as formatted JSON. Usage 
iblueprint get <id>
Arguments
ArgumentDescription
idThe UUID of the blueprint to fetch
Example 
iblueprint get 3f2a1b4c-0000-0000-0000-000000000001
Example output 
{
  "id": "3f2a1b4c-0000-0000-0000-000000000001",
  "title": "Customer Onboarding Flow",
  "status": "active",
  "nodes": [...],
  "edges": [...]
}
The exact fields returned depend on the blueprint’s configuration. Use this command to inspect node definitions and edge connections before executing.

​
iblueprint execute <id>

Triggers a blueprint chain execution and returns the execution ID you can use to track progress. Usage 
iblueprint execute <id> [--inputs <json>]
Arguments
ArgumentDescription
idThe UUID of the blueprint to execute
Flags
FlagShortDescription
--inputs <json>-i <json>A JSON string of input variables to pass to the blueprint
Examples Execute with no inputs: 
iblueprint execute 3f2a1b4c-0000-0000-0000-000000000001
Execute with input variables: 
iblueprint execute 3f2a1b4c-0000-0000-0000-000000000001 \
  --inputs '{"customer_name": "Acme Corp", "tier": "enterprise"}'
Example output 
Execution started, ID: exec_7a9b2c3d-0000-0000-0000-000000000099
The --inputs value must be valid JSON. The CLI passes it directly to JSON.parse(), so a malformed string will cause the command to exit with an error.

​
iblueprint status <execId>

Checks the current status of a blueprint chain execution. Usage 
iblueprint status <execId>
Arguments
ArgumentDescription
execIdThe execution ID returned by iblueprint execute
Example 
iblueprint status exec_7a9b2c3d-0000-0000-0000-000000000099
Example output 
Status: { id: 'exec_7a9b2c3d-…', status: 'completed', completedAt: '2026-05-12T14:30:00Z' }

​
End-to-end workflow example

A typical workflow using all four commands:
1

Find your blueprint

iblueprint list
Identify the blueprint you want to run and copy its id.
2

Inspect the blueprint

iblueprint get 3f2a1b4c-0000-0000-0000-000000000001
Review the blueprint’s nodes and required inputs before executing.
3

Execute the blueprint

iblueprint execute 3f2a1b4c-0000-0000-0000-000000000001 \
  --inputs '{"customer_name": "Acme Corp"}'
Copy the execution ID from the output.
4

Check execution status

iblueprint status exec_7a9b2c3d-0000-0000-0000-000000000099
Poll this command until the status shows completed.