---
canonical: https://docs.jentic.com/cli/arazzo-runner/
representation: markdown-alternate
# Canonical page: https://docs.jentic.com/cli/arazzo-runner/
# This is the Markdown alternate of the page above.
description: >-
  Use the Arazzo Runner CLI to execute Arazzo workflows and single OpenAPI operations
  from your terminal, with auth, dynamic parameters, and reusable logic.
---

# Arazzo Runner – CLI Reference

The **Arazzo Runner CLI** lets you execute workflows, run single API operations, and inspect workflow metadata directly from your terminal.
It is designed for both **development** and **automation**.

---

## Installation

```sh
pip install arazzo-runner
# or
uv add arazzo-runner
```

---

## Usage

```sh
uvx arazzo-runner <command> [options]
```

Run `--help` after any command for full usage details.

---

## Commands

### 1. `show-env-mappings`

Show environment variable mappings for authentication and server variables.

```sh
uvx arazzo-runner show-env-mappings [arazzo_path | --openapi-path PATH]
```

**Options:**

* `arazzo_path` – Path to an Arazzo YAML file
* `--openapi-path PATH` – Path to an OpenAPI spec

---

### 2. `execute-workflow`

Run a workflow from an Arazzo file.

```sh
uvx arazzo-runner execute-workflow <arazzo_path> \
  --workflow-id <id> \
  [--inputs '{"key":"value"}']
```

---

### 3. `execute-operation`

Run a single API operation.

```sh
uvx arazzo-runner execute-operation \
  [--arazzo-path PATH | --openapi-path PATH] \
  [--operation-id ID | --operation-path "METHOD /path"] \
  [--inputs '{"key":"value"}']
```

---

### 4. `list-workflows`

List all workflows in an Arazzo file.

```sh
uvx arazzo-runner list-workflows <arazzo_path>
```

---

### 5. `describe-workflow`

Show details about a specific workflow.

```sh
uvx arazzo-runner describe-workflow <arazzo_path> \
  --workflow-id <id>
```

---

### 6. `generate-example`

Generate an example CLI command for a workflow.

```sh
uvx arazzo-runner generate-example <arazzo_path> \
  --workflow-id <id>
```

---

## Global Options

* `--log-level {DEBUG,INFO,WARNING,ERROR,CRITICAL}` – Logging verbosity

---

## Examples

```sh
# Run a workflow
uvx arazzo-runner execute-workflow ./discord.arazzo.yaml \
  --workflow-id sendMessage \
  --inputs '{"recipient_id": "123", "content": "Hello"}'

# Show auth mappings
uvx arazzo-runner show-env-mappings ./discord.arazzo.yaml

# Run an operation by path
uvx arazzo-runner execute-operation \
  --openapi-path ./discord.openapi.json \
  --operation-path 'GET /users/@me/guilds'
```

---

## Related Links

* [Getting Started with Arazzo Runner](../getting-started/arazzo-runner.md)
* [Arazzo Format Specification](https://github.com/jentic/arazzo-engine/blob/main/runner/arazzo_spec/arazzo-spec.md)
* [Arazzo Runner Source Code](https://github.com/jentic/arazzo-engine)