README
¶
DataRobot CLI
The DataRobot CLI (dr) is a command-line interface for managing DataRobot custom applications. It provides an interactive experience for cloning, configuring, and deploying DataRobot application templates with built-in authentication, environment configuration, and task execution capabilities.
Features
- 🔐 Authentication management—seamless OAuth integration with DataRobot.
- 📦 Template management—clone and configure application templates interactively.
- ⚙️ Interactive configuration—smart wizard for environment setup with validation.
- 🚀 Task runner—execute application tasks with built-in Taskfile integration.
- 🐚 Shell completions—support for Bash, Zsh, Fish, and PowerShell.
- 🔄 Self-update capability—easily update to the latest version with a single command.
- 🎨 Beautiful TUI—terminal UI built with Bubble Tea for an enhanced user experience.
Table of Contents
Installation
Quick Install (Recommended)
Install the latest version with a single command:
macOS/Linux
curl https://cli.datarobot.com/install | sh
Windows (PowerShell)
irm https://cli.datarobot.com/winstall | iex
Install Specific Version
macOS/Linux (Specific Version)
curl https://cli.datarobot.com/install | sh -s -- v0.1.0
Windows (Specific Version)
$env:VERSION = "v0.1.0"; irm https://cli.datarobot.com/winstall | iex
Quick start
1. Set up authentication
Configure your DataRobot credentials:
# Set your DataRobot URL (interactive)
dr auth set-url
# Or specify directly
dr auth set-url https://app.datarobot.com
# Log in to DataRobot (opens browser for OAuth)
dr auth login
2. Set up a template
Use the interactive setup wizard to clone and configure a template:
dr templates setup
Follow the prompts to select a template, clone it, and configure environment variables.
3. Start your application
Once configured, launch your application with the quickstart command:
dr start
This will either execute your template's quickstart script or guide you through the setup process if one hasn't been completed yet.
4. Run tasks
Execute tasks defined in your template Taskfile:
# List available tasks
dr run --list
# Run a specific task
dr run dev
# Run multiple tasks in parallel
dr run lint test --parallel
Documentation
Comprehensive documentation is available in the docs/ directory:
-
User guide—complete usage guide for all features.
-
Template system—understanding the template configuration system.
-
Command reference—detailed command documentation.
- auth—authentication commands.
- templates—template management.
- run—task execution.
- dotenv—environment file management.
- completion—shell completion setup.
-
Development guide—for contributors, see CONTRIBUTING.md
Commands
Main commands
| Command | Description |
|---|---|
dr auth |
Authentication management (login, logout, set-url). |
dr templates |
Template operations (list, clone, setup, status). |
dr run |
Execute application tasks. |
dr dotenv |
Manage environment variables interactively. |
dr self |
CLI utility commands (update, version, completion). |
dr completion |
Generate shell completion scripts. |
dr version |
Show version information. |
Examples
# Authentication
dr auth login
dr auth logout
dr auth set-url https://app.datarobot.com
# Template management
dr templates list # List available templates.
dr templates clone TEMPLATE_NAME # Clone a specific template.
dr templates setup # Interactive template setup wizard.
dr templates status # Show current template status.
# Environment configuration
dr dotenv # Interactive environment editor.
dr dotenv --wizard # Configuration wizard mode.
# Task execution
dr run --list # List available tasks.
dr run dev # Run development server.
dr run build deploy --parallel # Run multiple tasks in parallel.
dr run test --watch # Run tests in watch mode.
# CLI management
dr self update # Update CLI to latest version.
dr self version # Show version information.
# Get help
dr --help
dr templates --help
dr run --help
Shell completion
The CLI supports shell completions for Bash, Zsh, Fish, and PowerShell with automatic installation and configuration.
Quick setup (Recommended)
The easiest way to install completions is using the interactive installer:
# Install completions for your current shell
dr completion install --yes
# Preview what would be installed (default behavior)
dr completion install
# Install for a specific shell
dr completion install bash --yes
dr completion install zsh --yes
The installer will:
- Detect your shell automatically
- Install completions to the correct location
- Configure your shell profile
- Clear completion caches
Note: Installation scripts (install.sh and install.ps1) automatically prompt to install completions during initial setup.
Manual setup
If you prefer manual installation, generate the completion script:
Bash
# Linux
dr completion bash | sudo tee /etc/bash_completion.d/dr
# macOS (requires bash-completion from Homebrew)
dr completion bash > $(brew --prefix)/etc/bash_completion.d/dr
Zsh
# Oh-My-Zsh
dr completion zsh > ~/.oh-my-zsh/custom/completions/_dr
# Standard Zsh
dr completion zsh > ~/.zsh/completions/_dr
Fish
dr completion fish > ~/.config/fish/completions/dr.fish
PowerShell
dr completion powershell | Out-String | Invoke-Expression
# To persist, add to your PowerShell profile
Uninstalling completions
dr completion uninstall --yes
See the Shell Completion Guide for detailed instructions and troubleshooting.
Contributing
We welcome contributions! Please see CONTRIBUTING.md for details on:
- Development environment setup
- Coding standards and guidelines
- Testing requirements
- Submitting pull requests
- Release process
License
Copyright 2025 DataRobot, Inc. and its affiliates. All rights reserved.
This is proprietary source code of DataRobot, Inc. See LICENSE.txt for details.
Support
Acknowledgments
Built with:
- Cobra—CLI framework
- Bubble Tea—terminal UI framework
- Viper—configuration management
- Task—task runner
Documentation
¶
There is no documentation for this package.
Source Files
Directories