reorc-cli

CLI tool for ReOrc platform.

Installation

npm install -g reorc-cli

Configuration

Before using the CLI, configure your environment:

reorc-cli config set
reorc-cli setup --website <login-url>

Commands

Project Management

# List all projects
reorc-cli projects list

# List project-scoped resources
reorc-cli projects use <project_id> data-models list
reorc-cli projects use <project_id> advanced-pipelines list
reorc-cli projects use <project_id> modeling-pipelines list
reorc-cli projects use <project_id> connections list
reorc-cli projects use <project_id> variables list

Variables

# List all variables (user + builtin)
reorc-cli projects use <project_id> variables list

# Get variable details
reorc-cli projects use <project_id> variables get <variable_name>

In Python or SQL code, reference variables using: {{ var("variable_name") }}

Pipelines

# Show how to write the YAML file
reorc-cli projects use <project_id> advanced-pipelines yaml-guide
reorc-cli projects use <project_id> advanced-pipelines yaml-guide --operator TransferOperator
reorc-cli projects use <project_id> advanced-pipelines yaml-guide --operator StreamOperator
reorc-cli projects use <project_id> advanced-pipelines yaml-guide --operator PythonOperator
reorc-cli projects use <project_id> advanced-pipelines yaml-guide --operator SQLOperator
reorc-cli projects use <project_id> advanced-pipelines yaml-guide --operator NotifyOperator
reorc-cli projects use <project_id> advanced-pipelines yaml-guide --operator SensorOperator

# TransferOperator: specify dump/load task types
reorc-cli projects use <project_id> advanced-pipelines yaml-guide --operator TransferOperator --dump-task S3DumpTask --load-task MySQLLoadTask

# StreamOperator: specify source and sink types
reorc-cli projects use <project_id> advanced-pipelines yaml-guide --operator StreamOperator --source-type postgres --sink-type starrocks

# NotifyOperator: specify message type
reorc-cli projects use <project_id> advanced-pipelines yaml-guide --operator NotifyOperator --msg-type interactive

# Export an advanced pipeline to YAML, inspect the local diff, then apply it back
reorc-cli projects use <project_id> advanced-pipelines use <pipeline_id> export
reorc-cli projects use <project_id> advanced-pipelines use <pipeline_id> diff
reorc-cli projects use <project_id> advanced-pipelines use <pipeline_id> apply

Data Models

# Create and organize data model directories
reorc-cli projects use <project_id> data-models manage new-directory --name <directory_name>
reorc-cli projects use <project_id> data-models manage move --model-id <model_id> --directory-id <directory_id>

# Export a data model to YAML, inspect the local diff, then apply it back
reorc-cli projects use <project_id> data-models use <model_id> export
reorc-cli projects use <project_id> data-models use <model_id> diff
reorc-cli projects use <project_id> data-models use <model_id> apply

Default YAML Paths

export, diff, and apply all use the default local YAML path for the selected resource:

• Advanced pipelines: ./reorc/project_<project_id>/advanced-pipelines/<directory>/<name>.yaml
• Source models: ./reorc/project_<project_id>/data-models/sources/<directory>/<name>.yaml
• Data models: ./reorc/project_<project_id>/data-models/models/<directory>/<name>.yaml

When a resource has no directory, the file is written directly under the sources/ or models/ subfolder. Names and directory segments are normalized into file-system-safe paths.

Output Formats

Most commands support --json flag for JSON output.

Global Connections

# List all global connections
reorc-cli global-connections list

Development

# Build
npm run build

# Run
npm start