CLI Reference

Command-line interface for BudAI Foundry operations

Overview

The bud CLI provides command-line access to BudAI Foundry platform features. It’s automatically installed with the Python SDK.

Installation

The CLI is included with the SDK:

pip install git+https://github.com/BudEcosystem/BudAIFoundry-SDK

Verify installation:

bud --version

Authentication Commands

Login

Authenticate with the BudAI Foundry platform:

bud auth login

This will prompt for your credentials and store them securely.

Check Status

View your current authentication status:

bud auth status

Logout

Remove stored credentials:

bud auth logout

Action Commands

List Actions

View all available pipeline actions:

bud action list

Get Action Details

View details for a specific action:

bud action get <action-name>

Pipeline Commands

Create Pipeline

Register a new pipeline from a YAML or Python file:

# From YAML file
bud pipeline create pipeline.yaml --name my-pipeline

# From Python file
bud pipeline create pipeline.py --name my-pipeline

List Pipelines

View all registered pipelines:

bud pipeline list

Get Pipeline

View details of a specific pipeline:

bud pipeline get <pipeline-id>

Delete Pipeline

Remove a pipeline:

bud pipeline delete <pipeline-id>

Execution Commands

Run Pipeline

Execute a pipeline with parameters:

# Run and wait for completion
bud run <pipeline-name> --param key=value --wait

# Run in background
bud run <pipeline-name> --param key=value

# Run with multiple parameters
bud run my-pipeline \
  --param input_file=data.csv \
  --param output_format=json \
  --wait

List Executions

View execution history:

# All executions
bud execution list

# Filter by status
bud execution list --status completed
bud execution list --status running
bud execution list --status failed

# Limit results
bud execution list --limit 10

Get Execution

View details of a specific execution:

bud execution get <execution-id>

Cancel Execution

Cancel a running execution:

bud execution cancel <execution-id>

Common Options

Most commands support these global options:

Option	Description
--help	Show help for command
--json	Output in JSON format
--verbose	Enable verbose logging
--quiet	Suppress non-essential output

Examples

Complete Workflow

# 1. Login
bud auth login

# 2. List available actions
bud action list

# 3. Create a pipeline
bud pipeline create my_pipeline.yaml --name data-processor

# 4. Run the pipeline
bud run data-processor \
  --param input_file=data.csv \
  --param output_dir=./results \
  --wait

# 5. Check execution status
bud execution list --status completed

Pipeline Development Workflow

# Create and test a pipeline
bud pipeline create pipeline.yaml --name test-pipeline

# Run with test data
bud run test-pipeline --param test_mode=true --wait

# View logs
bud execution get <execution-id>

# Update pipeline (delete and recreate)
bud pipeline delete <pipeline-id>
bud pipeline create updated_pipeline.yaml --name test-pipeline

Output Formats

Default (Human-Readable)

$ bud pipeline list

Pipelines:
ID                                    Name              Created
abc-123                              data-processor    2024-01-15
def-456                              ml-trainer        2024-01-16

JSON Format

$ bud pipeline list --json

{
  "pipelines": [
    {
      "id": "abc-123",
      "name": "data-processor",
      "created_at": "2024-01-15T10:30:00Z"
    }
  ]
}

Configuration

Config File Location

CLI configuration is stored at:

• Linux/macOS: ~/.bud/config.json
• Windows: %USERPROFILE%\.bud\config.json

Manual Configuration

Edit the config file directly:

{
  "api_key": "your-api-key",
  "base_url": "https://gateway.bud.studio",
  "default_project": "my-project"
}

Troubleshooting

Command Not Found

If bud command is not found:

# Ensure SDK is installed
pip install git+https://github.com/BudEcosystem/BudAIFoundry-SDK

# Check your PATH includes Python scripts
python -m site --user-base

Authentication Errors

If authentication fails:

# Re-login
bud auth logout
bud auth login

# Or set API key manually
export BUD_API_KEY=your-api-key

Pipeline Not Found

If pipeline isn’t found:

# List all pipelines
bud pipeline list

# Use pipeline ID instead of name
bud run <pipeline-id>