Skip to content

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

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

Usage

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.

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.

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

3. execute-operation

Run a single API operation.

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.

uvx arazzo-runner list-workflows <arazzo_path>

5. describe-workflow

Show details about a specific workflow.

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

6. generate-example

Generate an example CLI command for a workflow.

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

Global Options

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

Examples

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