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 and other Daytona components.
This reference lists all commands supported by the daytona
command-line tool complete with a description of their behavior, and any supported flags.
You can access this documentation on a per-command basis by appending the --help
/-h
flag when invoking daytona
.
This is the Daytona CLI used to manipulate workspaces from the command line.
code Starts the workspace in VS Code
create Initializes a workspace with the given git repository or a picked template
delete Commands the workspace given by ID to be destroyed
env Lists or manipulates environment variables
help Help about any command
ide Sets a default IDE for the current user
info Retrieves the information of workspace given by ID
list Shows a list of workspaces by the current user and team
login Authenticates the user using the browser
logout Logs user profile out of the CLI
pin Commands the workspace given by ID to become pinned
profile Lists available profiles to choose from
share Commands the workspace given by ID to become shared
ssh Connect to the workspace using Secure Shell
start Commands the workspace given by ID to start
stop Commands the workspace given by ID to stop
team Lists available teams to choose from
unpin Commands the workspace given by ID to become unpinned
unshare Commands the workspace given by ID to become unshared
version Returns the version of your Daytona CLI
-h, --help help for daytona
Use "daytona [command] --help" for more information about a command.
daytona
-h, --help help for daytona
daytona code
Starts the workspace in VS Code.
-i, --ide string Specify the IDE (e.g., ' vscode ' or ' browser ' )
daytona create
Use ' daytona create <GIT_URL> ' to instantiate a specific repository or ' daytona create ' to select one of your own. Using ' daytona create template ' lets you pick from a set of predefined templates.
-c, --code Open the project your default IDE after creating the workspace
-h, --help help for create
daytona delete
Commands the workspace given by ID to be destroyed: ' daytona delete <WORKSPACE_ID> ' . Use ' daytona delete --all ' to destroy all workspaces in the current team.
-o, --all Apply command to all workspaces
-h, --help help for delete
daytona env
Use ' daytona env ' to list environment variables or use ' daytona env <KEY>=<VALUE> ' to set them.
remove Removes the environment variable specified by key
Use " daytona env [command] --help " for more information about a command.
daytona help
Help provides help for any command in the application.
Simply type daytona help [path to command] for full details.
daytona help [command] [flags]
daytona ide
Displays a list of available IDEs to pick as default for the current user
-n, --name string Specify IDE by name
daytona info
Retrieves the information of workspace given by ID
daytona list
Shows a list of workspaces by the current user and team
daytona login
Opens the default browser and redirects to login page
-h, --help help for login
daytona logout
Logs the current user profile out of the Daytona CLI
-h, --help help for logout
daytona pin
Commands the workspace given by ID to become pinned (never gets deleted ): ' daytona pin <WORKSPACE_ID> ' .
daytona profile
Displays a list of available profiles to choose from.
daytona profile [command]
active Retrieves the ID of the currently active profile
info Displays information about the active profile
list Lists available profiles
new Creates a new profile
set -name Updates the name of the active profile to one given by argument
set -url Updates the base URL of the active profile to one given by argument
use Updates the active profile to one given by argument
-h, --help help for profile
Use " daytona profile [command] --help " for more information about a command.
daytona share
Commands the workspace given by ID to become shared (grants public access ): ' daytona share <WORKSPACE_ID> ' . Use ' daytona share --all ' to share all workspaces in the current team.
-o, --all Apply command to all workspaces
-h, --help help for share
daytona ssh
daytona start
Commands the workspace given by ID to start: ' daytona start <WORKSPACE_ID> ' . Use ' daytona start --all ' to start all workspaces in the current team.
-o, --all Apply command to all workspaces
-h, --help help for start
daytona stop
Commands the workspace given by ID to stop: ' daytona stop <WORKSPACE_ID> ' . Use ' daytona stop --all ' to stop all workspaces in the current team.
-o, --all Apply command to all workspaces
daytona team
Display list of available teams to choose from. Use flag ' --name ' to bypass prompt.
-n, --name string Specify team name
daytona unpin
Commands the workspace given by ID to become unpinned (will get deleted after being stopped for two weeks ): ' daytona unpin <WORKSPACE_ID> ' .
-h, --help help for unpin
daytona unshare
Commands the workspace given by ID to become unshared (removes public access ): ' daytona unshare <WORKSPACE_ID> ' . Use ' daytona unshare --all ' to unshare all workspaces in the current team.
-o, --all Apply command to all workspaces
-h, --help help for unshare
daytona version
Returns the version of your Daytona CLI
-h, --help help for version