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 --base-url <platform-url>
reorc-cli setup --url <login-url>

Commands

Project Management

# List all projects
reorc-cli projects list

# Get project details
reorc-cli get-project <project-id>

Models

# List models in a project (data sources first, then data models)
reorc-cli list-models <project-id-or-name>

# Get model details
reorc-cli get-model <model-id>

Pipelines

# List dbt models and data sources in a project
reorc-cli projects use <project_id> data-models list

# List advanced pipelines in a project
reorc-cli projects use <project_id> advanced-pipelines list

# List modeling pipelines in a project
reorc-cli projects use <project_id> modeling-pipelines list

# List connections in a project
reorc-cli projects use <project_id> connections list

# Get pipeline details with DAG visualization
reorc-cli get-pipeline <pipeline-id>

# Get pipeline details with ASCII DAG rendering
reorc-cli get-pipeline <pipeline-id> --render

# Get pipeline node details
reorc-cli get-pipeline-node <pipeline-id> <node-id>

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

# Export an advanced pipeline to YAML, edit it locally, then update it back
reorc-cli projects use <project_id> advanced-pipelines use <pipeline_id> export-yaml --file ./pipeline.yaml
reorc-cli projects use <project_id> advanced-pipelines use <pipeline_id> update-yaml --file ./pipeline.yaml

Output Formats

Most commands support --json flag for JSON output.

Global Connections

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

DAG Visualization

Pipeline DAGs are displayed using Mermaid syntax by default. Use --render flag to render ASCII art (requires java installed for Mermaid CLI).

Development

# Build
npm run build

# Run
npm start