# CLI

> CLI - Guides and references for using and developing the DataRobot CLI tool.

This Markdown file sits beside the HTML page at the same path (with a `.md` suffix). It summarizes the topic and lists links for tools and LLM context.

Companion generated at `2026-05-06T18:17:09.550715+00:00` (UTC).

## Primary page

- [CLI](https://docs.datarobot.com/en/docs/agentic-ai/cli/index.html): Full documentation for this topic (HTML).

## Sections on this page

- [Quick links](https://docs.datarobot.com/en/docs/agentic-ai/cli/index.html#quick-links): In-page section heading.
- [For setup](https://docs.datarobot.com/en/docs/agentic-ai/cli/index.html#for-setup): In-page section heading.
- [For templates](https://docs.datarobot.com/en/docs/agentic-ai/cli/index.html#for-templates): In-page section heading.
- [For agentic workflows](https://docs.datarobot.com/en/docs/agentic-ai/cli/index.html#for-agentic-workflows): In-page section heading.
- [For developers](https://docs.datarobot.com/en/docs/agentic-ai/cli/index.html#for-developers): In-page section heading.
- [Key features documented](https://docs.datarobot.com/en/docs/agentic-ai/cli/index.html#key-features-documented): In-page section heading.
- [1. Shell completions](https://docs.datarobot.com/en/docs/agentic-ai/cli/index.html#shell-completions): In-page section heading.
- [2. Template system](https://docs.datarobot.com/en/docs/agentic-ai/cli/index.html#template-system): In-page section heading.
- [3. Interactive configuration](https://docs.datarobot.com/en/docs/agentic-ai/cli/index.html#interactive-configuration): In-page section heading.
- [4. Environment management](https://docs.datarobot.com/en/docs/agentic-ai/cli/index.html#environment-management): In-page section heading.
- [Getting started](https://docs.datarobot.com/en/docs/agentic-ai/cli/index.html#getting-started): In-page section heading.
- [How to contribute to docs](https://docs.datarobot.com/en/docs/agentic-ai/cli/index.html#how-to-contribute-to-docs): In-page section heading.
- [Documentation principles](https://docs.datarobot.com/en/docs/agentic-ai/cli/index.html#documentation-principles): In-page section heading.
- [User-focused](https://docs.datarobot.com/en/docs/agentic-ai/cli/index.html#user-focused): In-page section heading.
- [Progressive disclosure](https://docs.datarobot.com/en/docs/agentic-ai/cli/index.html#progressive-disclosure): In-page section heading.
- [Maintainable](https://docs.datarobot.com/en/docs/agentic-ai/cli/index.html#maintainable): In-page section heading.
- [Discoverable](https://docs.datarobot.com/en/docs/agentic-ai/cli/index.html#discoverable): In-page section heading.
- [Get help](https://docs.datarobot.com/en/docs/agentic-ai/cli/index.html#get-help): In-page section heading.
- [Documentation tools](https://docs.datarobot.com/en/docs/agentic-ai/cli/index.html#documentation-tools): In-page section heading.
- [Version information](https://docs.datarobot.com/en/docs/agentic-ai/cli/index.html#version-information): In-page section heading.

## Related documentation

- [Agentic AI](https://docs.datarobot.com/en/docs/agentic-ai/index.html): Linked from this page.
- [Get started](https://docs.datarobot.com/en/docs/agentic-ai/cli/getting-started.html): Linked from this page.
- [Quick reference](https://docs.datarobot.com/en/docs/agentic-ai/cli/quick-reference.html): Linked from this page.
- [Shell completions](https://docs.datarobot.com/en/docs/agentic-ai/cli/shell-completions.html): Linked from this page.
- [Configuration](https://docs.datarobot.com/en/docs/agentic-ai/cli/configuration.html): Linked from this page.
- [Troubleshooting](https://docs.datarobot.com/en/docs/agentic-ai/agent-assist/troubleshooting.html): Linked from this page.
- [Template structure](https://docs.datarobot.com/en/docs/agentic-ai/cli/template-system/structure.html): Linked from this page.
- [Interactive configuration](https://docs.datarobot.com/en/docs/agentic-ai/cli/template-system/interactive-config.html): Linked from this page.
- [Environment variables](https://docs.datarobot.com/en/docs/agentic-ai/cli/template-system/environment-variables.html): Linked from this page.
- [Agentic quickstart](https://docs.datarobot.com/en/docs/agentic-ai/agentic-develop/agentic-quickstart.html): Linked from this page.
- [Develop agentic workflows](https://docs.datarobot.com/en/docs/agentic-ai/agentic-develop/index.html): Linked from this page.
- [Building from source](https://docs.datarobot.com/en/docs/agentic-ai/cli/development/building.html): Linked from this page.
- [Development setup](https://docs.datarobot.com/en/docs/agentic-ai/cli/development/setup.html): Linked from this page.
- [Project structure](https://docs.datarobot.com/en/docs/agentic-ai/cli/development/structure.html): Linked from this page.
- [Releasing](https://docs.datarobot.com/en/docs/agentic-ai/cli/development/releasing.html): Linked from this page.

## Documentation content

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
- Quick reference : One-page command and path reference
- Shell completions : Set up command auto-completion for your shell
- Configuration : Understand and manage config files
- Troubleshooting : Common issues and where to find solutions

### 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 agentic workflows

Building or deploying AI agents with DataRobot templates:

- Agentic AI : Create and evaluate agentic workflows
- Agentic quickstart : Set up and run agents with dr start and dr task run
- Develop agentic workflows : Installation, customization, tools, and deployment

### For developers

Resources for contributing and building:

- Building from source : Compile and build the CLI from source
- Development setup : Local development environment
- Project structure : Codebase organization
- Releasing : Release process

## Key features documented

### 1. Shell completions

Comprehensive documentation for setting up [auto-completion in multiple shells](https://docs.datarobot.com/en/docs/agentic-ai/cli/shell-completions.html):

- 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](https://docs.datarobot.com/en/docs/agentic-ai/cli/template-system/interactive-config.html):

- 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](https://docs.datarobot.com/en/docs/agentic-ai/cli/template-system/environment-variables.html):

- .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.2.x (latest: v0.2.38)
- Status : Active development
- Last updated : January 29, 2026
- Releases : GitHub Releases and CHANGELOG for release notes and version history