Skip to content

index.md

Latest commit

 

History

History
138 lines (92 loc) · 6.07 KB

index.md

File metadata and controls

138 lines (92 loc) · 6.07 KB

DataRobot CLI Documentation

Welcome to the DataRobot CLI documentation. This directory contains comprehensive guides and references for using and developing the DataRobot CLI tool.

Quick install

Install the latest version with a single command that auto-detects your operating system:

macOS/Linux:

curl https://cli.datarobot.com/install | sh

Windows (PowerShell):

irm https://cli.datarobot.com/winstall | iex

For more installation options, see the Installation section in the main README.

Documentation structure

📚 User guide

End-user documentation for using the CLI:

  • Getting started—installation and initial setup guide covering prerequisites, installation methods, authentication, and your first template.
  • Quick reference—one-page command reference for the most common commands.
  • Shell completions—set up command auto-completion for Bash, Zsh, Fish, and PowerShell.
  • Configuration files—understanding config file structure, location, and how to manage multiple environments.

🎯 Template system

Understanding the interactive template configuration:

  • Template structure—how templates are organized, including repository layout, metadata files, and multi-component templates.
  • Interactive configuration—the wizard system explained, including prompt types, conditional logic, and state management.
  • Environment variables—managing .env files, variable types, security best practices, and advanced features.

📖 Command reference

Detailed documentation for each command:

  • auth—authentication management including login, logout, and URL configuration.
  • start—quickstart process for automated template initialization.
  • run—task execution with automatic Taskfile discovery and parallel execution support.
  • task—Taskfile composition and management, including task listing and execution.
  • dotenv—environment variable management with interactive wizard and validation.
  • completion—shell completion setup (install/uninstall or generate for bash, zsh, fish, PowerShell).
  • self—CLI utility commands (version, update, config, completion, and plugin authoring: add, publish, package).
  • plugins—plugin system documentation.
  • component—component management and updates.
  • Command reference index—full command tree including dependencies check and global flags.

For template operations (list, setup), see the Template system documentation and use dr templates --help for command details.

🔧 Development guide

For contributors and developers:

  • Development setup—setting up your development environment with required tools and dependencies.
  • Building from source—compile and build the CLI, including build options and cross-platform builds.
  • Project structure—code organization and design, including directory structure and component overview.
  • Authentication—authentication implementation details and OAuth flow.
  • Release process—how releases are created, versioning, and release workflow.
  • Plugin development—creating and distributing plugins for the CLI.

Quick links

Getting help

If you can't find what you're looking for:

  1. Search existing issues.
  2. Open a new issue.
  3. Email: oss-community-management@datarobot.com.

For contributors

Documentation coverage

✅ Complete

  • Main README with comprehensive overview
  • Getting Started guide
  • Shell completions setup (all shells)
  • Configuration files guide
  • Template system structure and quickstart
  • Interactive configuration deep-dive
  • Environment variables management
  • auth, start, task, dotenv, completion, self, plugins, component commands
  • Command reference index with full tree (including dependencies, self plugin, completion install/uninstall)
  • Building from source guide

📝 To be added (Future)

  • User guide: authentication details, working with templates, FAQ
  • Command reference: dedicated page for dr templates (use dr templates --help and Template system in the meantime)
  • Development: architecture details, testing guide

Documentation principles

User-focused: Written from the user's perspective with task-oriented content and real-world examples.

Progressive disclosure: Quick start for beginners, deep-dive for advanced users, reference for specific details.

Maintainable: Keep in sync with code, update with each release, clear and consistent structure.

Discoverable: Good navigation, search-friendly, cross-referenced.

Local documentation preview

To preview the documentation site locally with MkDocs:

cd docs
uv sync
uv run mkdocs serve

Then open http://localhost:8000 in your browser.

Contributing to documentation

Found an error or want to improve the docs? Please see our Contributing Guidelines for information on submitting documentation improvements.

Documentation version: Synchronized with CLI version CLI version: 0.1.0+ Status: Active development