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 gives you direct terminal access to the iBlueprint platform, letting you list blueprints, trigger execution chains, and monitor results without opening a browser. It connects to the iBlueprint API using a simple environment variable and authenticates with an API key you generate from your account settings.

​
Installation

Install the CLI globally using npm: 
npm install -g @iblueprint/cli
After installation, verify the binary is available: 
iblueprint --version
You should see 1.0.0 printed to your terminal.

​
Configuration

The CLI connects to the iBlueprint API using the IBP_API_URL environment variable. If you do not set this variable, it defaults to http://localhost:4000 — useful for local development but not for production. Set IBP_API_URL to point at your iBlueprint instance: 
export IBP_API_URL=https://api.yourdomain.com
To persist the variable across sessions, add the export line to your shell profile (.bashrc, .zshrc, etc.).

​
Authentication

The CLI authenticates with the iBlueprint API using an API key passed as a Bearer token. Generate a key in Settings → API Keys, then make it available to the CLI: 
export IBP_API_KEY=ibp_your_api_key_here
API keys are scoped to your user account. Never commit them to source control. Use environment variables or a secrets manager instead.

​
Available commands

CommandDescription
iblueprint listList all blueprints in a table
iblueprint get <id>Fetch full blueprint details as JSON
iblueprint execute <id>Execute a blueprint chain
iblueprint status <execId>Check the status of an execution
See the CLI commands reference for full usage, flags, and output examples for every command.

​
Next steps

Commands reference

Full documentation for every CLI command, including flags and example output.

API keys

Learn how to create and manage the API keys the CLI uses to authenticate.