### Example Output: No Quickstart Script Found Source: https://docs.datarobot.com/en/docs/agentic-ai/cli/commands/start.html This output illustrates the scenario where no quickstart script is found by the dr start command. The process then proceeds to launch the interactive setup wizard. ```text DataRobot Quickstart ✓ Starting application quickstart process... ✓ Checking template prerequisites... ✓ Locating quickstart script... → Executing quickstart script... No quickstart script found. Will proceed with template setup... ``` -------------------------------- ### README Quick Start Example Source: https://docs.datarobot.com/en/docs/agentic-ai/cli/template-system/structure.html Provides a concise quick start guide within a README file, outlining the essential steps to clone, configure, and run a template. ```markdown # My template ## Quick start {: #quick-start } 1. Clone: `dr templates clone my-template` 2. Configure: `dr templates setup` 3. Run: `dr run dev` ``` -------------------------------- ### Example Output: Quickstart Script Found Source: https://docs.datarobot.com/en/docs/agentic-ai/cli/commands/start.html This output shows the expected messages when the dr start command successfully locates and executes a quickstart script. It includes confirmation prompts before proceeding. ```text DataRobot Quickstart ✓ Starting application quickstart process... ✓ Checking template prerequisites... ✓ Locating quickstart script... → Executing quickstart script... Quickstart found at: .datarobot/cli/bin/quickstart.sh. Will proceed with execution... Press 'y' or ENTER to confirm, 'n' to cancel ``` -------------------------------- ### Run DataRobot Applications Source: https://docs.datarobot.com/en/docs/agentic-ai/cli/quick-reference.html Start the quickstart or setup wizard, list tasks, and run development or build tasks. ```bash dr start # Quickstart or setup wizard dr task list # List tasks dr run dev # Run dev task dr run build dr run test ``` -------------------------------- ### DataRobot CLI Quickstart Examples Source: https://docs.datarobot.com/en/docs/agentic-ai/cli/commands/index.html Illustrates how to initiate the quickstart process for a DataRobot application, including running it interactively or with an auto-yes flag, and using its alias. ```bash # Run quickstart process (interactive) dr start # Run with auto-yes dr start --yes # Using the alias dr quickstart ``` -------------------------------- ### Run Interactive Template Setup Wizard Source: https://docs.datarobot.com/en/docs/agentic-ai/cli/commands/templates.html Use this command to start an interactive wizard that guides you through selecting, cloning, and configuring a project template. It handles environment setup and can optionally run `dr dotenv setup`. ```bash dr templates setup ``` -------------------------------- ### Test Custom Quickstart Script Source: https://docs.datarobot.com/en/docs/agentic-ai/cli/commands/start.html Run `dr start --yes` to test your custom quickstart script, bypassing confirmation prompts. ```bash dr start --yes ``` -------------------------------- ### Example: Run dotenv setup in a template directory Source: https://docs.datarobot.com/en/docs/agentic-ai/cli/commands/dotenv.html Navigate to your template directory and execute the `dr dotenv setup` command to begin the interactive configuration process. ```bash cd my-template dr dotenv setup ``` -------------------------------- ### Quickstart Script Naming Convention Source: https://docs.datarobot.com/en/docs/agentic-ai/cli/commands/start.html Quickstart scripts must start with 'quickstart' (case-sensitive) to be recognized by the dr start command. Multiple matching scripts will execute in lexicographical order. ```bash quickstart ``` ```bash quickstart.sh ``` ```bash quickstart.py ``` ```bash quickstart-dev ``` -------------------------------- ### Launch interactive dotenv setup Source: https://docs.datarobot.com/en/docs/agentic-ai/cli/commands/dotenv.html Use this command to start an interactive wizard for configuring environment variables. It guides you through prompts, discovers configurations, and handles secret values securely. Requires being run inside a git repository and authentication with DataRobot. ```bash dr dotenv setup ``` -------------------------------- ### Start New Project with File Source: https://docs.datarobot.com/en/docs/api/reference/sdk/projects.html Initiate a new project by providing a local file path for the data source. This method simplifies the initial setup of a project. ```python Project.start("./tests/fixtures/file.csv", "a_target", project_name="test_name", worker_count=4, metric="a_metric") ``` -------------------------------- ### Automatic Setup Wizard Launch Source: https://docs.datarobot.com/en/docs/agentic-ai/cli/commands/start.html When not in a DataRobot repository, `dr start` automatically launches the `dr templates setup` wizard without manual intervention. ```bash $ dr start # Automatically launches: dr templates setup ``` -------------------------------- ### Quickstart Script Location Source: https://docs.datarobot.com/en/docs/agentic-ai/cli/commands/start.html Quickstart scripts for the dr start command must be placed in the .datarobot/cli/bin/ directory within your project. ```bash .datarobot/cli/bin/ ``` -------------------------------- ### DataRobot CLI Template Management Examples Source: https://docs.datarobot.com/en/docs/agentic-ai/cli/commands/index.html Provides examples for managing DataRobot application templates, including listing available templates, cloning a specific template, initiating the interactive setup wizard, and checking the status of a template. ```bash # List templates dr templates list # Clone template dr templates clone python-streamlit # Interactive setup dr templates setup # Check status dr templates status ``` -------------------------------- ### Start Notebook Source: https://docs.datarobot.com/en/docs/api/reference/public-api/notebooks.html Starts a specified notebook. ```APIDOC ## POST /api/v2/notebookruntimes/notebooks/{notebookid}/start ### Description Starts a specified notebook. This action initiates the notebook's runtime environment. ### Method POST ### Endpoint /api/v2/notebookruntimes/notebooks/{notebookid}/start ### Parameters #### Path Parameters - **notebookid** (string) - Required - The unique identifier of the notebook. ``` -------------------------------- ### Start Notebooks by notebook ID Source: https://docs.datarobot.com/en/docs/api/reference/public-api/notebooks.html Starts a new notebook session for a given notebook ID. ```APIDOC ## POST /api/v2/notebookRuntimes/notebooks/{notebookId}/start/ ### Description Starts a new notebook session. ### Method POST ### Endpoint /api/v2/notebookRuntimes/notebooks/{notebookId}/start/ ### Parameters #### Path Parameters - **notebookId** (string) - Required - The notebook ID to start. ### Responses #### Success Response (200) - Schema for the execution status of a notebook session. (ExecutionStatusSchema) ``` -------------------------------- ### Create and Start Codespace Source: https://docs.datarobot.com/en/docs/api/reference/public-api/notebooks.html Schema for creating and starting a codespace, including repository details, environment configuration, and environment variables. ```APIDOC ## POST /codespaces ### Description Creates and starts a new codespace with specified configurations. ### Method POST ### Endpoint /codespaces ### Parameters #### Request Body - **cloneRepository** (object) - Optional - The repository to clone for the codespace. - **url** (string) - Required - The URL of the repository to clone. - **checkoutRef** (string) - Optional - The branch or commit to checkout. - **description** (string) - Optional - The description of the codespace. - **environment** (object) - Optional - The environment for the codespace. - **environmentId** (string) - Optional - The execution environment ID. - **environmentSlug** (string) - Optional - The execution environment slug. - **language** (string) - Optional - The programming language of the environment. - **languageVersion** (string) - Optional - The programming language version. - **machineId** (string) - Optional - The machine ID. - **machineSlug** (string) - Optional - The machine slug. - **timeToLive** (integer) - Optional - Inactivity timeout limit (minimum: 3, maximum: 525600). - **versionId** (string) - Optional - The execution environment version ID. - **environmentVariables** (array) - Optional - The environment variables for the codespace. - **name** (string) - Required - The name of the environment variable. - **value** (string) - Required - The value of the environment variable. - **description** (string) - Optional - The description of the environment variable. - **exposedPorts** (array) - Optional - The exposed ports for the codespace. - **port** (integer) - Required - Exposed port number. - **description** (string) - Optional - Description of the exposed port. - **name** (string) - Optional - The name of the codespace (defaults to "Untitled Codespace"). - **openFilePaths** (array) - Optional - The file paths to open in the codespace. - (string) - The file path to open. ``` -------------------------------- ### Notebooks API - Example Response Structure Source: https://docs.datarobot.com/en/docs/api/reference/public-api/notebooks.html This snippet illustrates the structure of example responses for the Notebooks API, focusing on deployment and metric details, as well as schedule configurations. ```APIDOC ## Notebooks API - Example Response Structure ### Description This section details the structure of example responses from the Notebooks API, including fields for deployment IDs, custom metric information, and scheduling parameters. ### Response Fields - **deploymentId** (string) - The ID of the deployment. - **metricId** (string) - The ID of the custom metric. - **metricName** (string) - The name of the custom metric. - **schedule** (object) - Configuration for the cron schedule. - **dayOfMonth** (array) - The day(s) of the month to run the schedule. Accepts integers or strings. - **dayOfWeek** (array) - The day(s) of the week to run the schedule. Accepts integers or strings. - **hour** (array) - The hour(s) to run the schedule. Accepts integers or strings. - **minute** (array) - The minute(s) to run the schedule. Accepts integers or strings. - **month** (array) - The month(s) to run the schedule. Accepts integers or strings. ### Response Example ```json { "deploymentId": "exampleDeploymentId", "metricId": "exampleMetricId", "metricName": "exampleMetricName", "schedule": { "dayOfMonth": [1, 15], "dayOfWeek": ["Monday", "Wednesday"], "hour": [9, 17], "minute": [0], "month": [1, 7] } } ``` ``` -------------------------------- ### Create And Start Codespace Source: https://docs.datarobot.com/en/docs/api/reference/public-api/notebooks.html Creates and starts a new codespace for a notebook. This is typically used to provision an environment for running notebook code. ```APIDOC ## POST /api/v2/notebookruntimes/notebooks/createandstartcodespace ### Description Creates and starts a codespace for a notebook. ### Method POST ### Endpoint /api/v2/notebookruntimes/notebooks/createandstartcodespace ### Parameters #### Request Body - **body** (object) - Required - Configuration details for the codespace. ``` -------------------------------- ### StartKernelRequest Source: https://docs.datarobot.com/en/docs/api/reference/public-api/notebooks.html Defines the request payload for starting a kernel, specifying the kernel's specification. ```APIDOC ## StartKernelRequest ### Description Request payload values for starting a kernel. ### Properties - **spec** (string) - Required - Name of the kernel to start. Possible values include 'python3', 'ir'. ``` -------------------------------- ### Start Notebook Session Source: https://docs.datarobot.com/en/docs/api/reference/public-api/notebooks.html Starts a new notebook session for a given notebook ID. This operation allows for configuration of repository cloning, triggered runs, file paths, and environment parameters. ```APIDOC ## POST /notebooks/{notebookId}/start ### Description Starts a new notebook session for a given notebook ID. ### Method POST ### Endpoint /notebooks/{notebookId}/start ### Parameters #### Path Parameters - **notebookId** (string) - Required - The notebook ID to start a session for. #### Request Body - **cloneRepository** (object) - Optional - Automatically tells the runner to clone remote repository if it's supported as part of its environment setup flow. - **url** (string) - Required - The URL of the repository to clone. - **checkoutRef** (string) - Optional - The branch or commit to checkout. - **isTriggeredRun** (boolean) - Optional - Indicates if the session is a triggered run versus an interactive run. Defaults to false. - **openFilePaths** (array) - Optional - List of file paths to open in the notebook session. - items (string) - **parameters** (array) - Optional - Parameters to use as environment variables. - items (object) - **name** (string) - Required - Environment variable name. Max length 256, pattern ^[a-z-A-Z0-9_]+$. - **value** (string) - Required - Environment variable value. Max length 131072. ### Request Example { "cloneRepository": { "url": "https://github.com/user/repo.git", "checkoutRef": "main" }, "isTriggeredRun": true, "openFilePaths": [ "notebooks/my_notebook.ipynb" ], "parameters": [ { "name": "MY_VAR", "value": "my_value" } ] } ### Response #### Success Response (200) - **description** (string) - Schema for starting a notebook session. - **properties** (object) - Properties of the notebook session schema. - **cloneRepository** (object) - Schema for cloning a repository. - **checkoutRef** (string) - The branch or commit to checkout. - **url** (string) - The URL of the repository to clone. - **isTriggeredRun** (boolean) - Indicates if the session is a triggered run versus an interactive run. - **openFilePaths** (array) - List of file paths to open in the notebook session. - items (string) - **parameters** (array) - Parameters to use as environment variables. - items (object) - **name** (string) - Environment variable name. - **value** (string) - Environment variable value. - **title** (string) - Schema for starting a notebook session. ``` -------------------------------- ### CreateAndStartCodespaceSchema Source: https://docs.datarobot.com/en/docs/api/reference/public-api/notebooks.html Schema for creating and starting a codespace, which includes notebook settings. ```APIDOC ## CreateAndStartCodespaceSchema ### Description This schema defines the structure for creating and starting a codespace, including various settings for notebooks. ### Properties - **settings** (object) - Optional - The settings for the codespace. - **allOf** (array) - Contains a single object describing Notebook UI settings. - **description** (string) - Notebook UI settings. - **properties** (object) - **hideCellFooters** (boolean) - Optional - Whether or not cell footers are hidden in the UI. Defaults to false. - **hideCellOutputs** (boolean) - Optional - Whether or not cell outputs are hidden in the UI. Defaults to false. - **hideCellTitles** (boolean) - Optional - Whether or not cell titles are hidden in the UI. Defaults to false. - **highlightWhitespace** (boolean) - Optional - Whether or whitespace is highlighted in the UI. Defaults to false. - **showLineNumbers** (boolean) - Optional - Whether or not line numbers are shown in the UI. Defaults to false. - **showScrollers** (boolean) - Optional - Whether or not scroll bars are shown in the UI. Defaults to false. - **title** (string) - NotebookSettings - **description** (string) - The settings for the codespace. - **title** (string) - Settings - **tags** (array) - Optional - The tags associated with the codespace. - **items** (string) - **title** (string) - Tags - **useCaseId** (string) - Required - The ID of the use case associated with the codespace. ### Required - useCaseId ``` -------------------------------- ### Create Kernel Source: https://docs.datarobot.com/en/docs/api/reference/public-api/notebooks.html Starts a new kernel for a given notebook session. You can specify the kernel's programming language. ```APIDOC ## Create Kernels by notebook ID ### Description Starts a new kernel for a given notebook session. ### Method POST ### Endpoint `/api/v2/notebookSessions/{notebookId}/kernels/` ### Parameters #### Path Parameters - **notebookId** (string) - Required - The ID of the notebook that the session belongs to. #### Request Body - **spec** (string) - Required - Name of the kernel to start. Possible values include 'python3', 'ir'. ### Request Example ```json { "spec": "python3" } ``` ### Response #### Success Response (201) - **id** (string) - The ID of the kernel. - **name** (string) - The name of the kernel. Possible values include 'python3', 'ir'. - **language** (string) - The programming language of the kernel. Possible values include 'python', 'r'. - **executionState** (string) - The execution state of the kernel. Possible values include 'connecting', 'disconnected', 'connected', 'starting', 'idle', 'busy', 'interrupting', 'restarting', 'not_running'. - **running** (boolean) - Whether the kernel is running. #### Response Example ```json { "id": "a1b2c3d4e5f6", "name": "python3", "language": "python", "executionState": "idle", "running": true } ``` ``` -------------------------------- ### Create And Start Codespace Source: https://docs.datarobot.com/en/docs/api/reference/public-api/notebooks.html Creates a new Codespace and starts a session for it. This operation is authenticated using Bearer Token. ```APIDOC ## POST /api/v2/notebookRuntimes/notebooks/createAndStartCodespace/ ### Description Creates the Codespace and starts a session. ### Method POST ### Endpoint /api/v2/notebookRuntimes/notebooks/createAndStartCodespace/ ``` -------------------------------- ### Scheduled Job Response Example Source: https://docs.datarobot.com/en/docs/api/reference/public-api/batch_predictions.html This example shows the structure of a successful response when retrieving scheduled job information. ```APIDOC ## GET /api/v1/scheduled_jobs ### Description Retrieves a list of scheduled prediction jobs. ### Method GET ### Endpoint /api/v1/scheduled_jobs ### Parameters #### Query Parameters - **limit** (integer) - Optional - The maximum number of items to return. - **offset** (integer) - Optional - The number of items to skip before starting to collect the result set. ### Response #### Success Response (200) - **count** (integer) - The number of items returned on this page. - **data** (array) - List of scheduled jobs. Each item has the following properties: - **createdBy** (string | null) - User name of the creator. - **deploymentId** (string | null) - ID of the deployment this scheduled job is created from. - **enabled** (boolean) - True if the job is enabled and false if the job is disabled. - **id** (string) - ID of scheduled prediction job. - **name** (string | null) - Name of the scheduled job. - **schedule** (object) - The scheduling information defining how often and when to execute this job. Optional if enabled = False. - **dayOfMonth** (array) - The date(s) of the month that the job will run. Allowed values are either ``[1 ... 31]`` or ``["*"]`` for all days of the month. This field is additive with ``dayOfWeek``. - **dayOfWeek** (array) - The day(s) of the week that the job will run. Allowed values are ``[0 .. 6]``, where (Sunday=0), or ``["*"]``, for all days of the week. This field is additive with ``dayOfMonth``. ### Response Example ```json { "count": 1, "data": [ { "createdBy": "user@example.com", "deploymentId": "deployment-123", "enabled": true, "id": "job-abc", "name": "Daily Prediction Run", "schedule": { "dayOfMonth": ["*"], "dayOfWeek": [1] } } ] } ``` ``` -------------------------------- ### Initial Setup: Set URL and Login Source: https://docs.datarobot.com/en/docs/agentic-ai/cli/commands/auth.html Recommended workflow for setting up authentication: first configure the DataRobot URL, then log in. ```bash # Set URL and login (recommended workflow) $ dr auth set-url https://app.datarobot.com ✓ DataRobot URL set to: https://app.datarobot.com $ dr auth login Opening browser for authentication... ✓ Successfully authenticated! ``` -------------------------------- ### Export Notebook to File Response Source: https://docs.datarobot.com/en/docs/api/reference/public-api/notebooks.html Example response when a notebook is successfully exported to a file. The response indicates the type of the exported content. ```json { "type": "string" } ``` -------------------------------- ### Taskfile Configuration Example Source: https://docs.datarobot.com/en/docs/agentic-ai/cli/commands/task.html This is a base Taskfile configuration that includes tasks from backend, frontend, and infra components. It defines default, start, lint, install, test, dev, deploy, and deploy-dev tasks. ```yaml version: '3' env: ENV: testing dotenv: ['.env', '.env.{{.ENV}}'] includes: backend: taskfile: ./backend/Taskfile.yaml dir: ./backend frontend: taskfile: ./frontend/Taskfile.yaml dir: ./frontend infra: taskfile: ./infra/Taskfile.yaml dir: ./infra tasks: default: desc: "ℹ️ Show all available tasks (run `task --list-all` to see hidden tasks)" cmds: - task --list --sort none silent: true start: desc: "💻 Prepare local development environment" cmds: - dr dotenv setup - task: install lint: desc: "🧹 Run linters" cmds: - task: backend:lint - task: frontend:lint install: desc: "🛠️ Install all dependencies" cmds: - task: backend:install - task: frontend:install - task: infra:install test: desc: "🧪 Run tests across all components" cmds: - task: backend:test - task: frontend:test dev: desc: "🚀 Run all services together" cmds: - | task backend:dev & sleep 3 task frontend:dev & sleep 8 echo "✅ All servers started!" wait deploy: desc: "🚀 Deploy all services" cmds: - task: infra:deploy - task: backend:deploy deploy-dev: desc: "🚀 Deploy all services to development" cmds: - task: infra:deploy-dev - task: backend:deploy-dev ``` -------------------------------- ### Quick Reference for Prediction Explanations Setup Source: https://docs.datarobot.com/en/docs/api/dev-learning/python/modeling/insights/prediction_explanations.html This snippet outlines the initial steps to set up for computing prediction explanations. It includes getting a project and model, computing feature impact, uploading a dataset, and requesting predictions. ```python import datarobot as dr # Get project my_projects = dr.Project.list() project = my_projects[0] # Get model models = project.get_models() model = models[0] # Compute feature impact feature_impacts = model.get_or_request_feature_impact() # Upload dataset dataset = project.upload_dataset('./data_to_predict.csv') # Compute predictions predict_job = model.request_predictions(dataset.id) predict_job.wait_for_completion() ``` -------------------------------- ### CreateAndStartCodespaceSchema Source: https://docs.datarobot.com/en/docs/api/reference/public-api/notebooks.html Schema for creating and starting a codespace. This includes details about repository cloning, environment configuration, environment variables, exposed ports, and file paths. ```APIDOC ## CreateAndStartCodespaceSchema ### Description Schema for creating and starting a codespace. ### Properties - **cloneRepository** (object) - Optional - The repository to clone for the codespace. - **url** (string) - Required - The URL of the repository to clone. - **checkoutRef** (string) - Optional - The branch or commit to checkout. - **description** (string) - Optional - The description of the codespace. - **environment** (object) - Optional - The environment for the codespace. - **environmentId** (string) - Optional - The execution environment ID. - **environmentSlug** (string) - Optional - The execution environment slug. - **language** (string) - Optional - The programming language of the environment. - **languageVersion** (string) - Optional - The programming language version. - **machineId** (string) - Optional - The machine ID. - **machineSlug** (string) - Optional - The machine slug. - **timeToLive** (integer) - Optional - Inactivity timeout limit (minimum: 3, maximum: 525600). - **versionId** (string) - Optional - The execution environment version ID. - **environmentVariables** (array) - Optional - The environment variables for the codespace. - **name** (string) - Required - The name of the environment variable. - **value** (string) - Required - The value of the environment variable. - **description** (string) - Optional - The description of the environment variable. - **exposedPorts** (array) - Optional - The exposed ports for the codespace. - **port** (integer) - Required - Exposed port number. - **description** (string) - Optional - Description of the exposed port. - **name** (string) - Optional - The name of the codespace (defaults to "Untitled Codespace"). - **openFilePaths** (array) - Optional - The file paths to open in the codespace. ``` -------------------------------- ### Manual Template Setup Steps Source: https://docs.datarobot.com/en/docs/agentic-ai/cli/getting-started.html Manually set up a template by first listing available templates, then setting up a template (which clones and configures it), navigating to the template directory, and finally configuring environment variables if needed. ```bash # 1. List available templates. dr templates list # 2. Set up a template (this clones and configures it). dr templates setup # 3. Navigate to the template directory. cd TEMPLATE_NAME # 4. Configure environment variables (if not done during setup). dr dotenv setup ``` -------------------------------- ### Setup Development Environment Source: https://docs.datarobot.com/en/docs/agentic-ai/cli/development/building.html Clone the repository and initialize the development environment using the provided commands. This includes cloning the repo and running the dev-init task. ```bash # Clone and setup git clone https://github.com/datarobot-oss/cli.git cd cli task dev-init ``` -------------------------------- ### Install pyenv and Dependencies on Ubuntu WSL Source: https://docs.datarobot.com/en/docs/api/code-first-tools/drum/custom-model-drum.html Installs pyenv, essential dependencies, and configures the bashrc for pyenv. This setup is required before installing DRUM. ```bash cd $HOME sudo apt update --yes sudo apt upgrade --yes sudo apt-get install --yes git git clone https://github.com/pyenv/pyenv.git ~/.pyenv #add pyenv to bashrc echo '# Pyenv environment variables' >> ~/.bashrc echo 'export PYENV_ROOT="$HOME/.pyenv"' >> ~/.bashrc echo 'export PATH="$PYENV_ROOT/bin:$PATH"' >> ~/.bashrc echo '# Pyenv initialization' >> ~/.bashrc echo 'if command -v pyenv 1>/dev/null 2>&1; then' >> ~/.bashrc echo ' eval "$(pyenv init -)"' >> ~/.bashrc echo 'fi' >> ~/.bashrc #restart shell exec $SHELL #install pyenv dependencies (copy as a single line) sudo apt-get install --yes libssl-dev zlib1g-dev libbz2-dev libreadline-dev libsqlite3-dev llvm libncurses5-dev libncursesw5-dev xz-utils tk-dev libgdbm-dev lzma lzma-dev tcl-dev libxml2-dev libxmlsec1-dev libffi-dev liblzma-dev wget curl make build-essential python-openssl #install python 3.7 (it can take awhile) pyenv install 3.7.10 ``` -------------------------------- ### Use dr quickstart Alias Source: https://docs.datarobot.com/en/docs/agentic-ai/cli/commands/start.html The dr start command can also be invoked using its alias, dr quickstart, to perform the same application quickstart process. ```bash dr quickstart ``` -------------------------------- ### Interactive Template Setup Source: https://docs.datarobot.com/en/docs/agentic-ai/cli/template-system/index.html Recommended method for setting up a new project from a template using an interactive wizard. ```bash # Interactive setup (recommended) dr templates setup ``` -------------------------------- ### Login using Cloud Instance Shortcuts Source: https://docs.datarobot.com/en/docs/agentic-ai/cli/commands/auth.html Demonstrates logging in using the predefined shortcuts for US, EU, and Japan cloud instances. ```bash # US Cloud dr auth set-url 1 dr auth login # EU Cloud dr auth set-url 2 dr auth login # Japan Cloud dr auth set-url 3 dr auth login ``` -------------------------------- ### Install Delve Debugger Source: https://docs.datarobot.com/en/docs/agentic-ai/cli/development/building.html Install the Delve debugger, a powerful tool for debugging Go programs. Use 'go install' to get the latest version. ```bash # Install delve go install github.com/go-delve/delve/cmd/dlv@latest ``` -------------------------------- ### Install Shell Completions via Script Source: https://docs.datarobot.com/en/docs/agentic-ai/cli/shell-completions.html Use this curl command to download and execute the installation script for automatic shell completion setup. Recommended for first-time installs. ```bash curl -fsSL https://raw.githubusercontent.com/datarobot-oss/cli/main/install.sh | sh ``` -------------------------------- ### Install Zsh completion script Source: https://docs.datarobot.com/en/docs/agentic-ai/cli/commands/completion.html Details the setup and installation of Zsh completion scripts. It includes options for user-specific or system-wide installation and how to clear the cache and reload the shell. ```zsh # Add to ~/.zshrc if not present autoload -U compinit compinit ``` ```zsh # Option 1: User completions directory mkdir -p ~/.zsh/completions dr self completion zsh > ~/.zsh/completions/_dr echo 'fpath=(~/.zsh/completions $fpath)' >> ~/.zshrc # Option 2: System directory dr self completion zsh > "${fpath[1]}/_dr" # Clear cache and reload rm -f ~/.zcompdump source ~/.zshrc ``` ```zsh source <(dr self completion zsh) ``` -------------------------------- ### Create Custom Quickstart Script Source: https://docs.datarobot.com/en/docs/agentic-ai/cli/commands/start.html Define your custom quickstart script using a heredoc to specify the commands to be executed. ```bash # Create the script cat > .datarobot/cli/bin/quickstart.sh <<'EOF' #!/bin/bash echo "Starting my custom quickstart..." dr run build dr run dev EOF ``` -------------------------------- ### Create Custom Quickstart Script Directory Source: https://docs.datarobot.com/en/docs/agentic-ai/cli/commands/start.html Use this command to create the necessary directory structure for a custom quickstart script. ```bash mkdir -p .datarobot/cli/bin ``` -------------------------------- ### Integrate Dotenv Setup with Templates Source: https://docs.datarobot.com/en/docs/agentic-ai/cli/commands/dotenv.html When setting up a new project template, `dotenv setup` is automatically executed. This ensures your environment variables are configured from the start. ```bash dr templates setup # Automatically runs dotenv setup ``` -------------------------------- ### Manual Template Setup Source: https://docs.datarobot.com/en/docs/agentic-ai/cli/template-system/index.html Clone a template manually and then set up environment variables and run the development server. ```bash # Manual setup dr templates clone my-template cd my-template dr dotenv setup dr run dev ```