Rodeo CLI Reference¶
This document covers the commands, options, and flags available in the Rodeo command-line interface.
General Usage¶
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.
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 formatJSON— Must be in JSONL (JSON Lines) format, with one JSON object per line
Examples:
# Process a CSV file with a single mapping
rodeo process ./config.yml ./data/customers.csv CSV ./mappings/customers.yaml
# Process a JSONL file with multiple mappings
rodeo process ./config.yml ./data/orders.json JSON ./mappings/orders.yaml ./mappings/order-items.yaml
# Process in the background
rodeo process ./config.yml ./data/large-export.csv CSV ./mappings/full-sync.yaml --background
rodeo jobs¶
List the current status of active Rodeo jobs.
Examples:
rodeo stream¶
Reconnect to a running job and view its progress.
Arguments:
| Argument | Description |
|---|---|
job_id |
The ID of the job to stream |
Examples:
rodeo version¶
Display the Rodeo service version number.
This shows the version of the rodeo-service component, which may differ from the CLI version shown by rodeo --version.
Typical Workflow¶
- Start a job in the background:
- Check job status:
- Stream logs from a running job:
Next Steps¶
See the Configuration File guide to set up your database connections, or the Mapping Files Guide to define your ETL transformations.