Skip to content

Rodeo CLI Reference

This document covers the commands, options, and flags available in the Rodeo command-line interface.

General Usage

rodeo [global-options] <command> [command-options] [arguments]

Global Options

Option Description
--version Display the CLI version number
--help Display help information

Commands

rodeo process

Process a data file through the ETL pipeline.

rodeo process <config_path> <file_path> <file_type> <mapping_paths...> [options]

Arguments:

Argument Description
config_path Path to the configuration file for database connection
file_path Path to the data file to process
file_type Type of input file: JSON or CSV
mapping_paths One or more mapping files defining the ETL transformations

Options:

Option Description
--background Run the job in the background

File Type Notes:

  • CSV — Standard comma-separated values format
  • JSON — Must be in JSONL (JSON Lines) format, with one JSON object per line

Examples:

# Process a CSV file with a single mapping
rodeo process /etc/rodeo/rodeo.conf ./data/customers.csv CSV ./mappings/customers.yaml

# Process a JSONL file with multiple mappings
rodeo process ./config.toml ./data/orders.json JSON ./mappings/orders.yaml ./mappings/order-items.yaml

# Process in the background
rodeo process /etc/rodeo/rodeo.conf ./data/large-export.csv CSV ./mappings/full-sync.yaml --background

rodeo job list

List all Rodeo jobs, including running and completed jobs.

rodeo job list

Examples:

# View all jobs
rodeo job list

rodeo job status

Show the current status of a specific job.

rodeo job status <job_id>

Arguments:

Argument Description
job_id The GUID of the job to check

Examples:

# Check status of a specific job
rodeo job status 550e8400-e29b-41d4-a716-446655440000

rodeo job watch

Reconnect to a running job and view its progress in real time.

rodeo job watch <job_id>

Arguments:

Argument Description
job_id The GUID of the job to watch

Examples:

# Watch progress of a background job
rodeo job watch 550e8400-e29b-41d4-a716-446655440000

rodeo job cancel

Cancel a running job.

rodeo job cancel <job_id>

Arguments:

Argument Description
job_id The GUID of the job to cancel

Examples:

# Cancel a running job
rodeo job cancel 550e8400-e29b-41d4-a716-446655440000

rodeo health

Check the health of the Rodeo service components.

rodeo health

This command reports the status of:

  • Web server — The Rodeo service API
  • Job processor — The background job processing engine

Examples:

# Check service health
rodeo health

rodeo version

Display the Rodeo service version number.

rodeo version

This shows the version of the rodeo-service component, which may differ from the CLI version shown by rodeo --version.

Typical Workflow

  1. Start a job in the background:
rodeo process ./config.yaml ./data/export.csv CSV ./mappings/sync.yaml --background
  1. List all jobs:
rodeo job list
  1. Check status of a specific job:
rodeo job status <job_id>
  1. Watch logs from a running job:
rodeo job watch <job_id>
  1. Cancel a job if needed:
rodeo job cancel <job_id>

Next Steps

See the Configuration File guide to set up your database connections, or the Mapping Files Guide to define your ETL transformations.