Skip to content

self.md

Latest commit

 

History

History
235 lines (161 loc) · 5.82 KB

self.md

File metadata and controls

235 lines (161 loc) · 5.82 KB
Raw

dr self - CLI utility commands

Commands for managing and configuring the DataRobot CLI itself.

Quick start

For most users, common CLI management tasks are straightforward:

# Check CLI version
dr self version

# Update to latest version
dr self update

# View current configuration
dr self config

These commands help you manage the CLI tool itself, including updates, version information, and configuration.

Note

First time? If you're new to the CLI, start with the Quick start for step-by-step setup instructions.

Synopsis

dr self <command>

Description

The self command provides utility functions for managing the CLI tool itself, including updating to the latest version, checking version information, setting up shell completion, and (for plugin authors) packaging and publishing plugins.

Subcommands

completion

Generate or manage shell completion scripts for command auto-completion.

dr self completion <shell>

See the completion documentation for detailed usage.

Quick examples:

# Install completions interactively
dr self completion install

# Generate completions for bash
dr self completion bash > /etc/bash_completion.d/dr

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

config

Display current configuration settings from config file and environment variables.

dr self config

This command shows all configuration values currently in use by the CLI, including settings from:

  • Configuration file (~/.config/datarobot/drconfig.yaml or custom path)
  • Environment variables (prefixed with DATAROBOT_CLI_ or standard DATAROBOT_ variables)
  • Command-line flags

Sensitive values like API tokens are automatically redacted for security.

Examples:

# Display current configuration
dr self config

Sample output:

Configuration initialized. Using config file: /Users/username/.config/datarobot/drconfig.yaml

  debug: false
  endpoint: https://app.datarobot.com/api/v2
  external_editor: vim
  token: ****
  verbose: false

Use cases:

  • Verify which configuration file is being used
  • Check that environment variables are being recognized
  • Debug configuration issues
  • Confirm API endpoint and settings before deployment

plugin

Plugin packaging and development tools for creating and publishing CLI plugins. These subcommands are for plugin authors and registry maintainers.

Subcommand Description
add <path-to-index.json> Add a packaged plugin version to a registry file (index.json).
publish <plugin-dir> Package and publish a plugin in one step (package, copy to plugins dir, update index).
package <plugin-dir> Package a plugin directory into a distributable .tar.xz archive.

See the Plugin development guide for details. For installing and managing plugins as a user, use the top-level dr plugin command.

update

Update the DataRobot CLI to the latest version.

dr self update

This command automatically detects your installation method and uses the appropriate update mechanism:

  • Homebrew (macOS)—uses brew update && upgrade dr-cli if installed via Homebrew
  • Windows—runs the PowerShell installation script
  • macOS/Linux—runs the shell installation script

The update process will download and install the latest version while preserving your configuration and credentials.

Examples:

# Update to latest version
dr self update

Note

This command requires an active internet connection and appropriate permissions to install software on your system.

version

Display version information about the CLI.

dr self version

Options:

  • --output-format—output format (text or json, default: text). -o is accepted as a deprecated alias (it maps to the legacy --format flag, not --output-format).
  • -s, --short—print just the version number (text format only)

Examples:

# Show version (default text format)
dr self version

# Show version in JSON format
dr self version --output-format json

# Show just the version number
dr self version --short

Global options

All dr global options are available:

  • -v, --verbose—enable verbose output
  • --debug—enable debug output
  • -h, --help—show help information

Examples

Update CLI to latest version

$ dr self update
Downloading latest version...
Installing DataRobot CLI...
✓ Successfully updated to v0.2.55

Check CLI version

$ dr self version
DataRobot CLI version: v0.2.55

View current configuration

$ dr self config
Configuration initialized. Using config file: /Users/username/.config/datarobot/drconfig.yaml

  debug: false
  endpoint: https://app.datarobot.com/api/v2
  external_editor: vim
  token: ****
  verbose: false

Install shell completions

# Interactive installation
$ dr self completion install
✓ Detected shell: zsh
✓ Installing completions to: ~/.zsh/completions/_dr
✓ Completions installed successfully!

# Manual installation
$ dr self completion bash | sudo tee /etc/bash_completion.d/dr

Get version in JSON

$ dr self version --output-format json
{
  "version": "v0.2.55",
  "commit": "abc1234def5678",
  "build_date": "2025-03-30T12:00:00Z"
}

See also