DataRobot CLI¶

This guide provides a comprehensive overview of all available documentation for the DataRobot CLI. The CLI (Command Line Interface) enables you to interact with DataRobot from your terminal, providing powerful automation capabilities for managing projects, templates, and workflows.

Quick links¶

For setup¶

Essential guides to get you started with the DataRobot CLI:

• Get started: Installation and initial setup
• Shell completions: Set up command auto-completion for your shell
• Configuration: Understand and manage config files

For templates¶

Learn how to work with the template system:

• Template structure: Understand how templates work
• Interactive configuration: Overview of the configuration wizard
• Environment variables: Manage .env files

For developers¶

Resources for contributing and building:

• Building from source: Compile and build the CLI from source

Key features documented¶

1. Shell completions¶

Comprehensive documentation for setting up auto-completion in multiple shells:

• Bash (Linux and macOS)
• Zsh
• Fish
• PowerShell

2. Template system¶

A detailed explanation of the template system including:

• Template repository structure
• .datarobot/prompts.yaml format
• Interactive configuration wizard
• Conditional prompts and sections
• Multi-level configuration

3. Interactive configuration¶

In-depth coverage of the interactive configuration system:

• Bubble Tea architecture
• Prompt types (text, selection, multi-select)
• Conditional logic with sections
• State management
• Keyboard controls
• Advanced features

4. Environment management¶

A complete guide to managing environment variables:

• .env vs .env.template
• Variable types (required, optional, secret)
• Interactive wizard
• Security best practices
• Common patterns

Getting started¶

If you're new to the DataRobot CLI, start here:

1. Installation and setup: Get the CLI installed and configured
2. Shell completions: Enable command auto-completion for faster workflows
3. Configuration: Understand how to configure the CLI for your environment

How to contribute to docs¶

We welcome contributions to improve the documentation! Here's how to get started:

1. Fork the repository to create your own copy
2. Edit or create markdown files in docs/
3. Follow the style guide:
4. Use clear, concise language
5. Include code examples where helpful
6. Add relevant cross-references
7. Use proper markdown formatting
8. Test links to ensure they work correctly
9. Submit a pull request with your changes

Documentation principles¶

Our documentation follows these key principles to ensure the best experience for all users:

User-focused¶

• Written from the user's perspective
• Task-oriented (how to accomplish something)
• Real-world examples and use cases

Progressive disclosure¶

• Quick start guides for beginners
• Deep-dive content for advanced users
• Reference material for specific details

Maintainable¶

• Kept in sync with code changes
• Updated with each release
• Clear, consistent structure throughout

Discoverable¶

• Good navigation and organization
• Search-friendly content
• Well cross-referenced

Get help¶

Can't find what you're looking for? Here are several ways to get assistance:

1. Search the docs: Use your browser's search function or GitHub's search feature
2. Check examples: Browse code examples in the docs/ directory
3. Ask questions: Open a Discussion on GitHub
4. Report issues: Missing or unclear documentation? Open an issue
5. Email us: Contact oss-community-management@datarobot.com for direct support

Documentation tools¶

The DataRobot CLI documentation uses:

• Markdown: All documentation is written in GitHub-flavored Markdown
• MkDocs (future): May add static site generation for better presentation
• GitHub Pages (future): May host documentation online for easier access

Version information¶

Documentation version: Synchronized with CLI version
CLI version: 0.1.0+
Status: Active development
Last updated: October 23, 2025