CLI
The daytona command-line tool provides access to Daytona’s core features.
You can use the daytona tool for the following operations:
- Managing the lifecycle of the Daytona Server.
- Managing Workspaces, Git Providers, Providers, and other Daytona components.
- Configuring the Daytona Server interactively.
This reference lists all commands supported by the daytona command-line tool complete with a description of their behaviour, and any supported flags.
You can access this documentation on a per-command basis by appending the --help/-h flag when invoking daytona.
daytona
Daytona is a Dev Environment Manager
daytona [flags]Flags
| Long | Short | Description |
|---|---|---|
--help | help for daytona | |
--version | -v | Display the version of Daytona |
daytona api-key
Api Key commands
daytona api-key [flags]Flags
| Long | Short | Description |
|---|---|---|
--help | help for daytona |
daytona api-key generate
Generate a new API key
daytona api-key generate [NAME] [flags]Flags
| Long | Short | Description |
|---|---|---|
--help | help for daytona |
daytona api-key list
List API keys
daytona api-key list [flags]Flags
| Long | Short | Description |
|---|---|---|
--format | -f | Output format. Must be one of (yaml, json) |
--help | help for daytona |
daytona api-key revoke
Revoke an API key
daytona api-key revoke [NAME] [flags]Flags
| Long | Short | Description |
|---|---|---|
--yes | -y | Skip confirmation prompt |
--help | help for daytona |
daytona autocomplete
Adds a completion script for your shell environment
daytona autocomplete [bash|zsh|fish|powershell] [flags]Flags
| Long | Short | Description |
|---|---|---|
--help | help for daytona |
daytona build
Manage builds
daytona build [flags]Flags
| Long | Short | Description |
|---|---|---|
--help | help for daytona |
daytona build delete
Delete a build
daytona build delete [BUILD] [flags]Flags
| Long | Short | Description |
|---|---|---|
--all | -a | Delete ALL builds |
--force | -f | Force delete build |
--prebuild-id | Delete ALL builds from prebuild | |
--help | help for daytona |
daytona build info
Show build info
daytona build info [BUILD] [flags]Flags
| Long | Short | Description |
|---|---|---|
--format | -f | Output format. Must be one of (yaml, json) |
--help | help for daytona |
daytona build list
List all builds
daytona build list [flags]Flags
| Long | Short | Description |
|---|---|---|
--format | -f | Output format. Must be one of (yaml, json) |
--help | help for daytona |
daytona build logs
View logs for build
daytona build logs [flags]Flags
| Long | Short | Description |
|---|---|---|
--follow | -f | Follow logs |
--help | help for daytona |
daytona build run
Run a build from a project config
daytona build run [flags]Flags
| Long | Short | Description |
|---|---|---|
--help | help for daytona |
daytona code
Open a workspace in your preferred IDE
daytona code [WORKSPACE] [PROJECT] [flags]Flags
| Long | Short | Description |
|---|---|---|
--ide | -i | Specify the IDE (vscode, browser, cursor, ssh, jupyter, fleet, zed, clion, goland, intellij, phpstorm, pycharm, rider, rubymine, webstorm) |
--yes | -y | Automatically confirm any prompts |
--help | help for daytona |
daytona config
Output Daytona configuration
daytona config [flags]Flags
| Long | Short | Description |
|---|---|---|
--format | -f | Output format. Must be one of (yaml, json) |
--show-api-keys | -k | Show API keys |
--help | help for daytona |
daytona container-registry
Manage container registries
daytona container-registry [flags]Flags
| Long | Short | Description |
|---|---|---|
--help | help for daytona |
daytona container-registry delete
Delete a container registry
daytona container-registry delete [flags]Flags
| Long | Short | Description |
|---|---|---|
--help | help for daytona |
daytona container-registry list
Lists container registries
daytona container-registry list [flags]Flags
| Long | Short | Description |
|---|---|---|
--format | -f | Output format. Must be one of (yaml, json) |
--help | help for daytona |
daytona container-registry set
Set container registry
daytona container-registry set [flags]Flags
| Long | Short | Description |
|---|---|---|
--password | -p | Password |
--server | -s | Server |
--username | -u | Username |
--help | help for daytona |
daytona create
Create a workspace
daytona create [REPOSITORY_URL | PROJECT_CONFIG_NAME]... [flags]Flags
| Long | Short | Description |
|---|---|---|
--blank | Create a blank project without using existing configurations | |
--branch | Specify the Git branches to use in the projects | |
--builder | Specify the builder (currently auto/devcontainer/none) | |
--custom-image | Create the project with the custom image passed as the flag value; Requires setting —custom-image-user flag as well | |
--custom-image-user | Create the project with the custom image user passed as the flag value; Requires setting —custom-image flag as well | |
--devcontainer-path | Automatically assign the devcontainer builder with the path passed as the flag value | |
--env | Specify environment variables (e.g. —env ‘KEY1=VALUE1’ —env ‘KEY2=VALUE2’ …‘) | |
--git-provider-config | Specify the Git provider configuration ID or alias | |
--ide | -i | Specify the IDE (vscode, browser, cursor, ssh, jupyter, fleet, zed, clion, goland, intellij, phpstorm, pycharm, rider, rubymine, webstorm) |
--manual | Manually enter the Git repository | |
--multi-project | Workspace with multiple projects/repos | |
--name | Specify the workspace name | |
--no-ide | -n | Do not open the workspace in the IDE after workspace creation |
--target | -t | Specify the target (e.g. ‘local’) |
--yes | -y | Automatically confirm any prompts |
--help | help for daytona |
daytona delete
Delete a workspace
daytona delete [WORKSPACE] [flags]Flags
| Long | Short | Description |
|---|---|---|
--all | -a | Delete all workspaces |
--force | -f | Delete a workspace by force |
--yes | -y | Confirm deletion without prompt |
--help | help for daytona |
daytona docs
Opens the Daytona documentation in your default browser.
daytona docs [flags]Flags
| Long | Short | Description |
|---|---|---|
--help | help for daytona |
daytona env
Manage profile environment variables that are added to all workspaces
daytona env [flags]Flags
| Long | Short | Description |
|---|---|---|
--help | help for daytona |
daytona env list
List profile environment variables
daytona env list [flags]Flags
| Long | Short | Description |
|---|---|---|
--format | -f | Output format. Must be one of (yaml, json) |
--help | help for daytona |
daytona env set
Set profile environment variables
daytona env set [KEY=VALUE]... [flags]Flags
| Long | Short | Description |
|---|---|---|
--help | help for daytona |
daytona forward
Forward a port from a project to your local machine
daytona forward [PORT] [WORKSPACE] [PROJECT] [flags]Flags
| Long | Short | Description |
|---|---|---|
--public | Should be port be available publicly via an URL | |
--help | help for daytona |
daytona git-providers
Manage Git providers
daytona git-providers [flags]Flags
| Long | Short | Description |
|---|---|---|
--help | help for daytona |
daytona git-providers add
Register a Git provider
daytona git-providers add [flags]Flags
| Long | Short | Description |
|---|---|---|
--help | help for daytona |
daytona git-providers delete
Unregister a Git provider
daytona git-providers delete [flags]Flags
| Long | Short | Description |
|---|---|---|
--all | -a | Remove all Git providers |
--yes | -y | Confirm deletion without prompt |
--help | help for daytona |
daytona git-providers list
Lists your registered Git providers
daytona git-providers list [flags]Flags
| Long | Short | Description |
|---|---|---|
--format | -f | Output format. Must be one of (yaml, json) |
--help | help for daytona |
daytona git-providers update
Update a Git provider
daytona git-providers update [flags]Flags
| Long | Short | Description |
|---|---|---|
--help | help for daytona |
daytona ide
Choose the default IDE
daytona ide [flags]Flags
| Long | Short | Description |
|---|---|---|
--help | help for daytona |
daytona info
Show workspace info
daytona info [WORKSPACE] [flags]Flags
| Long | Short | Description |
|---|---|---|
--format | -f | Output format. Must be one of (yaml, json) |
--help | help for daytona |
daytona list
List workspaces
daytona list [flags]Flags
| Long | Short | Description |
|---|---|---|
--format | -f | Output format. Must be one of (yaml, json) |
--verbose | -v | Show verbose output |
--help | help for daytona |
daytona logs
View logs for a workspace/project
daytona logs [WORKSPACE] [PROJECT_NAME] [flags]Flags
| Long | Short | Description |
|---|---|---|
--follow | -f | Follow logs |
--workspace | -w | View workspace logs |
--help | help for daytona |
daytona prebuild
Manage prebuilds
daytona prebuild [flags]Flags
| Long | Short | Description |
|---|---|---|
--help | help for daytona |
daytona prebuild add
Add a prebuild configuration
daytona prebuild add [PROJECT_CONFIG] [flags]Flags
| Long | Short | Description |
|---|---|---|
--branch | -b | Git branch for the prebuild |
--commit-interval | -c | Commit interval for running a prebuild - leave blank to ignore push events |
--retention | -r | Maximum number of resulting builds stored at a time |
--run | Run the prebuild once after adding it | |
--trigger-files | -t | Full paths of files whose changes should explicitly trigger a prebuild |
--help | help for daytona |
daytona prebuild delete
Delete a prebuild configuration
daytona prebuild delete [PROJECT_CONFIG] [PREBUILD] [flags]Flags
| Long | Short | Description |
|---|---|---|
--force | -f | Force delete prebuild |
--help | help for daytona |
daytona prebuild info
Show prebuild configuration info
daytona prebuild info [flags]Flags
| Long | Short | Description |
|---|---|---|
--format | -f | Output format. Must be one of (yaml, json) |
--help | help for daytona |
daytona prebuild list
List prebuild configurations
daytona prebuild list [flags]Flags
| Long | Short | Description |
|---|---|---|
--format | -f | Output format. Must be one of (yaml, json) |
--help | help for daytona |
daytona prebuild update
Update a prebuild configuration
daytona prebuild update [PROJECT_CONFIG] [PREBUILD_ID] [flags]Flags
| Long | Short | Description |
|---|---|---|
--branch | -b | Git branch for the prebuild |
--commit-interval | -c | Commit interval for running a prebuild - leave blank to ignore push events |
--retention | -r | Maximum number of resulting builds stored at a time |
--run | Run the prebuild once after updating it | |
--trigger-files | -t | Full paths of files whose changes should explicitly trigger a prebuild |
--help | help for daytona |
daytona profile
Manage profiles
daytona profile [flags]Flags
| Long | Short | Description |
|---|---|---|
--help | help for daytona |
daytona profile add
Add profile
daytona profile add [flags]Flags
| Long | Short | Description |
|---|---|---|
--api-key | -k | API Key |
--api-url | -a | API URL |
--name | -n | Profile name |
--help | help for daytona |
daytona profile delete
Delete profile [PROFILE_NAME]
daytona profile delete [flags]Flags
| Long | Short | Description |
|---|---|---|
--help | help for daytona |
daytona profile edit
Edit profile [PROFILE_NAME]
daytona profile edit [flags]Flags
| Long | Short | Description |
|---|---|---|
--api-key | -k | API Key |
--api-url | -a | API URL |
--name | -n | Profile name |
--help | help for daytona |
daytona profile list
List profiles
daytona profile list [flags]Flags
| Long | Short | Description |
|---|---|---|
--format | -f | Output format. Must be one of (yaml, json) |
--help | help for daytona |
daytona project-config
Manage project configs
daytona project-config [flags]Flags
| Long | Short | Description |
|---|---|---|
--help | help for daytona |
daytona project-config add
Add a project config
daytona project-config add [flags]Flags
| Long | Short | Description |
|---|---|---|
--builder | Specify the builder (currently auto/devcontainer/none) | |
--custom-image | Create the project with the custom image passed as the flag value; Requires setting —custom-image-user flag as well | |
--custom-image-user | Create the project with the custom image user passed as the flag value; Requires setting —custom-image flag as well | |
--devcontainer-path | Automatically assign the devcontainer builder with the path passed as the flag value | |
--env | Specify environment variables (e.g. —env ‘KEY1=VALUE1’ —env ‘KEY2=VALUE2’ …‘) | |
--git-provider-config | Specify the Git provider configuration ID or alias | |
--manual | Manually enter the Git repository | |
--name | Specify the project config name | |
--help | help for daytona |
daytona project-config delete
Delete a project config
daytona project-config delete [flags]Flags
| Long | Short | Description |
|---|---|---|
--all | -a | Delete all project configs |
--force | -f | Force delete prebuild |
--yes | -y | Confirm deletion without prompt |
--help | help for daytona |
daytona project-config info
Show project config info
daytona project-config info [flags]Flags
| Long | Short | Description |
|---|---|---|
--format | -f | Output format. Must be one of (yaml, json) |
--help | help for daytona |
daytona project-config list
Lists project configs
daytona project-config list [flags]Flags
| Long | Short | Description |
|---|---|---|
--format | -f | Output format. Must be one of (yaml, json) |
--help | help for daytona |
daytona project-config set-default
Set project config info
daytona project-config set-default [flags]Flags
| Long | Short | Description |
|---|---|---|
--help | help for daytona |
daytona project-config update
Update a project config
daytona project-config update [flags]Flags
| Long | Short | Description |
|---|---|---|
--help | help for daytona |
daytona provider
Manage providers
daytona provider [flags]Flags
| Long | Short | Description |
|---|---|---|
--help | help for daytona |
daytona provider install
Install provider
daytona provider install [flags]Flags
| Long | Short | Description |
|---|---|---|
--yes | -y | Automatically confirm any prompts |
--help | help for daytona |
daytona provider list
List installed providers
daytona provider list [flags]Flags
| Long | Short | Description |
|---|---|---|
--format | -f | Output format. Must be one of (yaml, json) |
--help | help for daytona |
daytona provider uninstall
Uninstall provider
daytona provider uninstall [flags]Flags
| Long | Short | Description |
|---|---|---|
--help | help for daytona |
daytona provider update
Update provider
daytona provider update [flags]Flags
| Long | Short | Description |
|---|---|---|
--all | -a | Update all providers |
--help | help for daytona |
daytona purge
Purges all Daytona data from the current device
daytona purge [flags]Flags
| Long | Short | Description |
|---|---|---|
--force | -f | Delete all workspaces by force |
--yes | -y | Execute purge without prompt |
--help | help for daytona |
daytona restart
Restart a workspace
daytona restart [WORKSPACE] [flags]Flags
| Long | Short | Description |
|---|---|---|
--project | -p | Restart a single project in the workspace (project name) |
--help | help for daytona |
daytona serve
Run the server process in the current terminal session
daytona serve [flags]Flags
| Long | Short | Description |
|---|---|---|
--help | help for daytona |
daytona server
Start the server process in daemon mode
daytona server [flags]Flags
| Long | Short | Description |
|---|---|---|
--yes | -y | Skip the confirmation prompt |
--help | help for daytona |
daytona server config
Output local Daytona Server config
daytona server config [flags]Flags
| Long | Short | Description |
|---|---|---|
--format | -f | Output format. Must be one of (yaml, json) |
--help | help for daytona |
daytona server configure
Configure Daytona Server
daytona server configure [flags]Flags
| Long | Short | Description |
|---|---|---|
--help | help for daytona |
daytona server logs
Output Daytona Server logs
daytona server logs [flags]Flags
| Long | Short | Description |
|---|---|---|
--file | Read logs from local server log file | |
--follow | -f | Follow logs |
--help | help for daytona |
daytona server restart
Restarts the Daytona Server daemon
daytona server restart [flags]Flags
| Long | Short | Description |
|---|---|---|
--help | help for daytona |
daytona server start
Start the Daytona Server daemon
daytona server start [flags]Flags
| Long | Short | Description |
|---|---|---|
--help | help for daytona |
daytona server stop
Stops the Daytona Server daemon
daytona server stop [flags]Flags
| Long | Short | Description |
|---|---|---|
--help | help for daytona |
daytona ssh
SSH into a project using the terminal
daytona ssh [WORKSPACE] [PROJECT] [CMD...] [flags]Flags
| Long | Short | Description |
|---|---|---|
--option | -o | Specify SSH options in KEY=VALUE format. |
--yes | -y | Automatically confirm any prompts |
--help | help for daytona |
daytona start
Start a workspace
daytona start [WORKSPACE] [flags]Flags
| Long | Short | Description |
|---|---|---|
--all | -a | Start all workspaces |
--code | -c | Open the workspace in the IDE after workspace start |
--project | -p | Start a single project in the workspace (project name) |
--yes | -y | Automatically confirm any prompts |
--help | help for daytona |
daytona stop
Stop a workspace
daytona stop [WORKSPACE] [flags]Flags
| Long | Short | Description |
|---|---|---|
--all | -a | Stop all workspaces |
--project | -p | Stop a single project in the workspace (project name) |
--help | help for daytona |
daytona target
Manage provider targets
daytona target [flags]Flags
| Long | Short | Description |
|---|---|---|
--help | help for daytona |
daytona target list
List targets
daytona target list [flags]Flags
| Long | Short | Description |
|---|---|---|
--format | -f | Output format. Must be one of (yaml, json) |
--help | help for daytona |
daytona target remove
Remove target
daytona target remove [TARGET_NAME] [flags]Flags
| Long | Short | Description |
|---|---|---|
--yes | -y | Confirm deletion of all workspaces without prompt |
--help | help for daytona |
daytona target set-default
Set target to be used by default
daytona target set-default [TARGET_NAME] [flags]Flags
| Long | Short | Description |
|---|---|---|
--help | help for daytona |
daytona target set
Set provider target
daytona target set [flags]Flags
| Long | Short | Description |
|---|---|---|
--help | help for daytona |
daytona telemetry
Manage telemetry collection
daytona telemetry [flags]Flags
| Long | Short | Description |
|---|---|---|
--help | help for daytona |
daytona telemetry disable
Disable telemetry collection
daytona telemetry disable [flags]Flags
| Long | Short | Description |
|---|---|---|
--help | help for daytona |
daytona telemetry enable
Enable telemetry collection
daytona telemetry enable [flags]Flags
| Long | Short | Description |
|---|---|---|
--help | help for daytona |
daytona use
Use profile [PROFILE_NAME]
daytona use [flags]Flags
| Long | Short | Description |
|---|---|---|
--help | help for daytona |
daytona version
Print the version number
daytona version [flags]Flags
| Long | Short | Description |
|---|---|---|
--help | help for daytona |
daytona whoami
Display information about the active user
daytona whoami [flags]Flags
| Long | Short | Description |
|---|---|---|
--format | -f | Output format. Must be one of (yaml, json) |
--help | help for daytona |