> ## Documentation Index
> Fetch the complete documentation index at: https://doc.blankstate.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# CLI

> Shell access to the IBF API.

Install the `bks` CLI.

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

## Authentication

```bash theme={null}
bks auth login
```

This opens the Atlas login flow and stores a token locally. For CI environments:

```bash theme={null}
export BKS_KEY=your_api_key
```

## Sense

```bash theme={null}
bks sense \
  --protocol empathy \
  --actant user_001 \
  --content "I understand this has been difficult..."
```

Pass a file instead of inline content:

```bash theme={null}
bks sense --protocol empathy --file transcript.txt
```

## Run a Blueprint

```bash theme={null}
bks sense --blueprint advisory-quality --file call.txt
```

## List Protocols

```bash theme={null}
bks protocols list
```

## Inspect a Signature

```bash theme={null}
bks signatures get user_001
```

## Usage

```bash theme={null}
bks usage
```

## Options

| Flag          | Description                                      |
| ------------- | ------------------------------------------------ |
| `--protocol`  | Protocol id or comma-separated list              |
| `--blueprint` | Blueprint id                                     |
| `--actant`    | Actant id for Signature tracking                 |
| `--modality`  | `text` (default), `transcript`, `audio`, `video` |
| `--fidelity`  | Override fidelity threshold (0–1)                |
| `--json`      | Output raw JSON                                  |
| `--quiet`     | Suppress headers and labels                      |