Quick reference
Quick reference
One-page reference for the most common DataRobot CLI (dr) commands and paths.
Installation
# macOS/Linux
curl https://cli.datarobot.com/install | sh
# Windows (PowerShell)
irm https://cli.datarobot.com/winstall | iex
Authentication
dr auth set-url https://app.datarobot.com # or 1=US, 2=EU, 3=JP
dr auth login
dr auth logout
Templates
dr templates list
dr templates setup
dr templates clone <name> [directory]
dr templates status
Running applications
dr start # Quickstart or setup wizard
dr task list # List tasks
dr run dev # Run dev task
dr run build
dr run test
Environment
dr dotenv setup
dr dotenv edit
dr dotenv validate
dr dotenv update
Deploying Workloads
dr workload config # Describe the project; writes .datarobot.yaml
dr workload up # Deploy, or apply what changed since the last deploy
dr workload up --dry-run # Show the plan and stop
dr workload up --yes # Ask nothing (CI)
dr workload status # Reads the Workload ID from .datarobot.yaml
dr workload logs --follow
dr workload promote # Lock the version that is running
dr workload delete --purge # Remove the Workload and what the deploy created
See Tutorial: Deploy from a project folder and Manage Workloads with the CLI. The Workload API is a premium feature.
Local experimentation (dr xp)
dr plugin install xp
dr xp # Opens on the Assist tab; pick an entity from the Entities tab
dr xp --entity-id <USE_CASE_ID> # Opens on the Tracing tab for the use case
dr xp --enable-evaluation --entity-id <USE_CASE_ID> # Evaluation tab (preview)
dr xp --enable-trace-analysis --entity-id <USE_CASE_ID> # Trace analysis controls on the Tracing page (preview)
curl -s http://127.0.0.1:8090/api/info # Verify enabled features
| Setting |
Flag / env |
Default |
| Port |
--port / DR_EXPERIMENT_PORT |
8090 |
| Entity ID |
--entity-id / DR_EXPERIMENT_ENTITY_ID |
DATAROBOT_USE_CASE_ID in pulumi_config.json, then DATAROBOT_DEFAULT_USE_CASE; optional. |
| Assist tab |
--enable-assist / DR_EXPERIMENT_ENABLE_ASSIST |
On |
| Entities tab |
--enable-entities / DR_EXPERIMENT_ENABLE_ENTITIES |
On; when off, --entity-id is required. |
| Evaluation tab |
--enable-evaluation / DR_EXPERIMENT_ENABLE_EVALUATION=true |
Off |
| Trace analysis |
--enable-trace-analysis / DR_EXPERIMENT_ENABLE_TRACE_ANALYSIS=true |
Off |
See DataRobot experimentation plugin, Local tracing, Batch agent evaluation, and Trace analysis.
CLI self-management
dr --version
dr self version
dr self update
dr self config
dr self completion bash | sudo tee /etc/bash_completion.d/dr
Global flags
| Flag |
Description |
-v, --verbose |
Verbose output |
--debug |
Debug output (creates dr-tui-debug.log) |
--skip-auth |
Skip authentication (advanced) |
--force-interactive |
Force setup wizard to run again |
-h, --help |
Help |
Config and state paths
| Platform |
Config file |
| Linux/macOS |
~/.config/datarobot/drconfig.yaml |
| Windows |
%USERPROFILE%\.config\datarobot\drconfig.yaml |
| Location |
Purpose |
.datarobot/cli/state.yaml |
Template state (per template directory) |
See also