開発者向けドキュメント > DataRobot CLI > Command reference

Command reference¶

Complete reference documentation for all DataRobot CLI commands.

Global flags¶

These flags are available for all commands:

  -v, --verbose       Enable verbose output (info level logging)
      --debug         Enable debug output (debug level logging)
      --skip-auth     Skip authentication checks (for advanced users)
      --force-interactive  Force the setup wizard to run even if already completed
  -h, --help          Show help information

Warning: The --skip-auth flag is intended for advanced use cases only. Using this flag will bypass all authentication checks, which may cause API calls to fail. Use with caution.

Note: The --force-interactive flag forces commands to behave as if setup has never been completed, while still updating the state file. This is useful for testing or forcing re-execution of setup steps.

Commands¶

Main commands¶

Command	説明
`auth`	Authenticate with DataRobot.
`templates`	Manage application templates.
`start`	Run the application quickstart process.
`run`	Execute application tasks.
`task`	Manage Taskfile composition and task execution.
`dotenv`	Manage environment variables.
`self`	CLI utility commands (update, version, completion).

Command tree¶

dr
├── auth                Authentication management
│   ├── login          Log in to DataRobot
│   ├── logout         Log out from DataRobot
│   └── set-url        Set DataRobot URL
├── templates          Template management
│   ├── list           List available templates
│   ├── clone          Clone a template
│   ├── setup          Interactive setup wizard
│   └── status         Show template status
├── start              Run quickstart process (alias: quickstart)
├── run                Task execution
├── task               Taskfile composition and execution
│   ├── compose        Compose unified Taskfile
│   ├── list           List available tasks
│   └── run            Execute tasks
├── dotenv             Environment configuration
└── self               CLI utility commands
    ├── completion     Shell completion
    │   ├── bash       Generate bash completion
    │   ├── zsh        Generate zsh completion
    │   ├── fish       Generate fish completion
    │   └── powershell Generate PowerShell completion
    ├── config         Display configuration settings
    ├── update         Update CLI to latest version
    └── version        Version information

Quick examples¶

認証¶

# Set URL and login
dr auth set-url https://app.datarobot.com
dr auth login

# Logout
dr auth logout

テンプレート¶

# List templates
dr templates list

# Clone template
dr templates clone python-streamlit

# Interactive setup
dr templates setup

# Check status
dr templates status

クイックスタート¶

# Run quickstart process (interactive)
dr start

# Run with auto-yes
dr start --yes

# Using the alias
dr quickstart

Environment configuration¶

# Interactive wizard
dr dotenv setup

# Editor mode
dr dotenv edit

# Validate configuration
dr dotenv validate

Running tasks¶

# List available tasks
dr run --list

# Run a task
dr run dev

# Run multiple tasks
dr run lint test --parallel

Shell completions¶

# Bash (Linux)
dr self completion bash | sudo tee /etc/bash_completion.d/dr

# Zsh
dr self completion zsh > "${fpath[1]}/_dr"

# Fish
dr self completion fish > ~/.config/fish/completions/dr.fish

CLI management¶

# Update to latest version
dr self update

# Check version
dr self version

Command details¶

For detailed documentation on each command, see:

auth—authentication management.
login—OAuth authentication.
logout—remove credentials.
set-url—configure DataRobot URL.
templates—template operations.
list—list available templates.
clone—clone a template repository.
setup—interactive wizard for full setup.
status—show current template status.
run—task execution.
Execute template tasks.
List available tasks.
Parallel execution support.
Watch mode for development.
task—Taskfile composition and management.
compose—generate unified Taskfile from components.
list—list all available tasks.
run—execute tasks.
dotenv—environment management.
Interactive configuration wizard.
Direct file editing.
Variable validation.
completion—shell completions.
Bash, Zsh, Fish, PowerShell support.
Auto-complete commands and flags.
version—version information.
Show CLI version.
Build information.
Runtime details.

サポートについて¶

# General help
dr --help
dr -h

# Command help
dr auth --help
dr templates --help
dr run --help

# Subcommand help
dr auth login --help
dr templates clone --help

環境変数¶

Global environment variables that affect all commands:

# Configuration
DATAROBOT_ENDPOINT             # DataRobot URL
DATAROBOT_API_TOKEN            # API token (not recommended)

Exit codes¶

コード	Meaning
0	Success.
1	General error.
2	Command usage error.
130	Interrupted (Ctrl+C).