Project structure

This page describes the organization of the DataRobot CLI codebase.

Directory overview

cli/
├── cmd/                     # Command implementations (Cobra)
│   ├── root.go              # Root command and global flags
│   ├── auth/                # Authentication commands
│   ├── component/           # Component management commands
│   ├── dotenv/              # Environment variable management
│   ├── run/                 # Task execution
│   ├── self/                # Self-management commands
│   ├── start/               # Application startup
│   ├── task/                # Task commands
│   ├── templates/           # Template management
│   └── workload/            # Workload lifecycle commands (feature-gated)
├── internal/                # Private application code
│   ├── assets/              # Embedded assets
│   ├── auth/                # Authentication logic (OAuth-style browser flow)
│   ├── cli/                 # CLI infrastructure (GatedCommand, etc.)
│   ├── config/              # Configuration management
│   ├── copier/              # Template copying utilities
│   ├── drapi/               # DataRobot API client
│   ├── envbuilder/          # Environment builder
│   ├── features/            # Feature flag system
│   ├── misc/                # Miscellaneous utilities
│   ├── repo/                # Repository detection
│   ├── shell/               # Shell utilities
│   ├── task/                # Task discovery and execution
│   ├── telemetry/           # Anonymous usage analytics (Amplitude)
│   ├── tools/               # Tool prerequisites
│   ├── version/             # Version information
│   └── workload/            # Workload manifest, wizard, deploy, and sync engine
├── tui/                     # Terminal UI components
│   ├── banner.go            # Banner display
│   ├── interrupt.go         # Interrupt handling
│   ├── program.go           # TUI execution wrapper
│   └── theme.go             # Visual theme
├── docs/                    # Documentation
│   ├── commands/            # Command reference
│   ├── development/         # Development guides
│   ├── template-system/     # Template system docs
│   └── user-guide/          # User documentation
├── smoke_test_scripts/      # Smoke tests
├── main.go                  # Application entry point
├── Taskfile.yaml            # Task definitions
├── go.mod                   # Go module definition
└── goreleaser.yaml          # Release configuration

Key directories

cmd/

Contains all CLI command implementations using the Cobra framework. Each subdirectory represents a command or command group.

Structure

root.go is the root command setup and global flags
Each command has its own subdirectory with cmd.go as the entry point
Commands that have subcommands are in the same directory

Example

cmd/auth/cmd.go: The auth command group
cmd/auth/login/cmd.go: The login subcommand
cmd/auth/logout/cmd.go: The logout subcommand
...

internal/

Private application code that cannot be imported by other projects. This follows Go's convention for internal packages.

config/

The configuration management directory, including:

Reading/writing configuration files
Authentication states
User preferences

drapi/

DataRobot API client implementation for:

Template listing and retrieval
API authentication
API endpoint communication

See the package doc (go doc ./internal/drapi) for the timeout-override convention and the HTTPError/errors.As contract new commands should follow when wiring in a call, or drapi client conventions for the same content as a dev doc.

auth/

OAuth-style browser login flow (auth.EnsureAuthenticated, used as a PreRunE gate on any command that needs credentials) plus the credential-verification and interactive URL-picker logic behind dr auth login/set-url. See Authentication for the full flow.

workload/

Manifest parsing/compilation, the dr workload config setup wizard, the dr workload up deploy orchestrator, and the code-sync engine behind dr artifact code sync. A dedicated architecture guide is in review with the Workload API team; until it lands, internal/workload/*/doc.go (e.g. go doc ./internal/workload/up) is the best available reference.

envbuilder/

An environment configuration builder that:

Discovers environment variables from templates via discovery.go
Validates YAML prompt files via schema.go using struct-based schema validation
Generates .env files with proper formatting and comments
Provides interactive prompts with conditional logic and auto-generation

Key files:

builder.go: Core prompt types (UserPrompt, PromptOption) and merging logic
schema.go: YAML unmarshaling (UnmarshalPromptFile) and validation (PromptFileSchema)
discovery.go: Recursive discovery of .datarobot directories and prompt files
validator.go: Validation rules for environment variables
validator_test.go: Comprehensive validation tests

cli/

CLI infrastructure and utilities:

CommandAdder: Wraps a cobra.Command and overrides AddCommand to skip children with a disabled feature gate annotation
Used by the root command (and any parent command with gated children) to filter commands at registration time

features/

Feature flag system:

SetGate: Marks a command with a feature gate annotation
Enabled: Checks if a feature is enabled via environment variables
AnnotationKey: The key used for feature gate annotations
Environment variable format: DATAROBOT_CLI_FEATURE_<NAME> (e.g., DATAROBOT_CLI_FEATURE_WORKLOAD_ALPHA=true)

task/

Task discovery and execution:

Taskfile detection
Task parsing
Task running
Output handling

tui/

Terminal UI components built with Bubble Tea:

Reusable UI models
Theme definitions
Interrupt handling for graceful exits
Banner displays

docs/

Documentation organized by audience:

commands/: Detailed command reference
development/: Development guides for contributors
template-system/: Template configuration system
user-guide/: End-user documentation

Code organization patterns

Command structure

Each command follows this pattern:

Note: All top-level commands use singular names (e.g., template, dependency, plugin) for consistency. Plural aliases are available for backward compatibility and should be added when renaming existing commands.

// cmd/example/cmd.go
package example

import "github.com/spf13/cobra"

var Cmd = &cobra.Command{
    Use:   "example",
    Short: "Example command",
    Long:  `Detailed description`,
    PreRunE: func(cmd *cobra.Command, args []string) error {
        // Validation and setup
        return nil
    },
    RunE: func(cmd *cobra.Command, args []string) error {
        // Command implementation
        return nil
    },
}

func init() {
    // Flag definitions
    Cmd.Flags().StringP("flag", "f", "", "Flag description")
}

TUI models

TUI components use the Bubble Tea framework and are executed using the tui.Run wrapper, which handles Ctrl-C signals and pauses stderr logging (but not .dr-tui-debug.log) while program is running:

// cmd/example/model.go
package example

import (
    tea "github.com/charmbracelet/bubbletea"
    "github.com/datarobot/cli/tui"
)

type model struct {
    // State fields
}

func (m model) Init() tea.Cmd {
    return nil
}

func (m model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
    // Handle messages
    return m, nil
}

func (m model) View() string {
    // Render UI
    return ""
}

// Usage in command
func runInteractive() error {
    m := model{}
    _, err := tui.Run(m)
    return err
}

Configuration

Configuration is managed through Viper and stored in:

~/.config/datarobot/drconfig.yaml: Global configuration and authentication tokens

Access configuration through internal/config and its viperx wrapper (the only supported way to read/write viper state — spf13/viper cannot be imported directly outside internal/config):

import (
    "github.com/datarobot/cli/internal/config"
    "github.com/datarobot/cli/internal/config/viperx"
)

// Get configuration values
apiKey := viperx.GetString(config.DataRobotAPIKey)
endpoint := config.GetBaseURL()

// Persist a value — only keys listed in config.PersistableKeys are written
viperx.Set(config.DataRobotURL, "https://app.datarobot.com")
config.UpdateConfigFile(config.DataRobotURL)

See Configuration for the full contract (persistable keys, env-var binding, redaction rules).

Testing structure

Tests are colocated with the code they test:

Unit tests: *_test.go files in the same package
Test helpers in same directory when needed
Smoke tests in the smoke_test_scripts/ directory

Build artifacts

Generated files and artifacts:

dist/: Build outputs (created by Task/GoReleaser)
tmp/: Temporary build files
coverage.txt: Test coverage reports

Next steps

Setup guide: setting up your development environment
Build guide: Detailed build information and architecture
Contributing guide—contribution guidelines.

Navigation Menu

Repository navigation

structure.md

structure.md

Project structure

Directory overview

Key directories

cmd/

Structure

Example

internal/

config/

drapi/

auth/

workload/

envbuilder/

cli/

features/

task/

tui/

docs/

Code organization patterns

Command structure

TUI models

Configuration

Testing structure

Build artifacts

Next steps

FilesExpand file tree

structure.md

Latest commit

History

structure.md

File metadata and controls

Project structure

Directory overview

Key directories

cmd/

Structure

Example

internal/

config/

drapi/

auth/

workload/

envbuilder/

cli/

features/

task/

tui/

docs/

Code organization patterns

Command structure

TUI models

Configuration

Testing structure

Build artifacts

Next steps