cli

README

DataRobot CLI

Homepage · Documentation · Support

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 start
• Next steps
• Contributing

Installation

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

Alternative installation methods

The following are alternative installation methods for the DataRobot CLI. You can choose to install a specific version or build and install from source.

Install specific version

If you'd like to install a specific version, you can do so by passing the version number to the installer, as shown below:

macOS/Linux

curl  https://cli.datarobot.com/install | sh -s -- v0.1.0

Windows (PowerShell)

$env:VERSION = "v0.1.0"; irm https://cli.datarobot.com/winstall | iex

Build and install from source

If you would like to build and install from source, you can do so by following the instructions below:

Prerequisites

• Go 1.25.3 or later (for building from source).
• Git.
• Task (for development and task running).

Build from source

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

Now that you have installed the DataRobot CLI, you can start using it to manage your DataRobot applications. The following sections will walk you through configuring the CLI, setting up a template, and running tasks.

Set up authentication

First, configure your DataRobot credentials by setting your DataRobot URL. Refer to DataRobot's API keys and tools page for steps to locate your DataRobot URL, also known as your DataRobot API endpoint.

# Set your DataRobot URL (interactive)
dr auth set-url # Or specify directly: dr auth set-url [YOUR_DATAROBOT_API_ENDPOINT]

Once you have configured the URL, log in to DataRobot. This command will open your default web browser to the DataRobot login page.

dr auth login

Once you have logged in, the DataRobot web application prompts you to authorize the CLI. Click "Authorize" to complete the authorization process, then close the browser window once it is complete.

Set up a template

Next, load the interactive setup wizard to clone and configure a template:

dr templates setup

After a few moments, the setup wizard displays the application templates available:

[!NOTE] You can navigate through the list of templates using the arrow keys, or filter by pressing the / key and entering a search term. The setup wizard will only display templates that are available to you.

Select a template by pressing the Enter key. At the subsequent prompt, specify the desired directory name for the template and press Enter to have the setup wizard clone the template repository to your local machine.

Follow the instructions when prompted to continue configuring the template. The prompts vary depending on which template you selected. When all steps are finished, press Enter to exit the wizard and proceed to the next section.

Run tasks

Now that you've cloned and configured a template, you can start running tasks defined in the template Taskfile. First, navigate to the template directory:

cd [TEMPLATE_NAME]

From there, you can list the available tasks:

dr run

Next steps

From here, refer to the Docs section of this repository for more details on using the DataRobot CLI. See the links below for specific details:

• User guide—complete usage guide for all features.

  • Getting started
  • Authentication
  • Working with templates
  • Shell completions
  • Configuration files

• Template system—understanding the template configuration system.

  • Template structure
  • Interactive configuration
  • Environment variables

• 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

Contributing

We welcome contributions! Please see CONTRIBUTING.md for details on:

• Code of conduct.
• Development workflow.
• Submitting pull requests.
• Coding standards.
• Testing requirements.

Support

• 📖 Documentation
• 🐛 Issue Tracker
• 💬 Discussions
• 📧 Email: oss-community-management@datarobot.com

Acknowledgments

Built with:

• Cobra—CLI framework.
• Bubble Tea—terminal UI framework.
• Viper—configuration management.
• Task—task runner.