> ## 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.

# iBlueprint CLI: install, configure, and authenticate

> Install and configure the iBlueprint CLI to run blueprints, trigger executions, and check statuses directly from your terminal or CI pipeline.

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:

```bash theme={null}
npm install -g @iblueprint/cli
```

After installation, verify the binary is available:

```bash theme={null}
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:

<CodeGroup>
  ```bash macOS / Linux theme={null}
  export IBP_API_URL=https://api.yourdomain.com
  ```

  ```powershell Windows theme={null}
  $env:IBP_API_URL = "https://api.yourdomain.com"
  ```
</CodeGroup>

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:

```bash theme={null}
export IBP_API_KEY=ibp_your_api_key_here
```

<Note>
  API keys are scoped to your user account. Never commit them to source control. Use environment variables or a secrets manager instead.
</Note>

## Available commands

| Command                      | Description                          |
| ---------------------------- | ------------------------------------ |
| `iblueprint list`            | List 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     |

<Tip>
  See the [CLI commands reference](/cli/commands) for full usage, flags, and output examples for every command.
</Tip>

## Next steps

<CardGroup cols={2}>
  <Card title="Commands reference" icon="terminal" href="/cli/commands">
    Full documentation for every CLI command, including flags and example output.
  </Card>

  <Card title="API keys" icon="key" href="/account/api-keys">
    Learn how to create and manage the API keys the CLI uses to authenticate.
  </Card>
</CardGroup>