Back to Daytona

CLI

apps/docs/src/content/docs/en/tools/cli.mdx

0.175.012.6 KB
Original Source

import { TabItem, Tabs } from "@astrojs/starlight/components"; import Aside from "@components/Aside.astro"; import Label from "@components/Label.astro";

Daytona provides command-line access to core features for interacting with Daytona Sandboxes, including managing their lifecycle, snapshots, and more.

The CLI 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.

Installation

Install the Daytona CLI to interact with Daytona sandboxes from the command line.

<Tabs syncKey="language"> <TabItem label="Mac/Linux">
bash
brew install daytonaio/cli/daytona
</TabItem> <TabItem label="Windows">
bash
powershell -Command "irm https://get.daytona.io/windows | iex"
</TabItem> </Tabs>

After installing the Daytona CLI, use the daytona command to interact with Daytona Sandboxes from the command line.

Update

To update the Daytona CLI to the latest version:

<Tabs syncKey="language"> <TabItem label="Mac/Linux">
bash
brew upgrade daytonaio/cli/daytona
</TabItem> <TabItem label="Windows">
bash
powershell -Command "irm https://get.daytona.io/windows | iex"
</TabItem> </Tabs>

daytona

Daytona CLI

shell
daytona [flags]

Flags

LongShortDescription
--helphelp for daytona
--version-vDisplay the version of Daytona

daytona archive

Archive a sandbox

shell
daytona archive [SANDBOX_ID] | [SANDBOX_NAME] [flags]

Flags

LongShortDescription
--helphelp for daytona

daytona autocomplete

Adds a completion script for your shell environment

shell
daytona autocomplete [bash|zsh|fish|powershell] [flags]

Flags

LongShortDescription
--helphelp for daytona
<Aside type="note"> If using bash shell environment, make sure you have bash-completion installed in order to get full autocompletion functionality. Linux Installation: ```sudo apt-get install bash-completion``` macOS Installation: ```brew install bash-completion``` </Aside>

daytona create

Create a new sandbox

shell
daytona create [flags]

Flags

LongShortDescription
--auto-archiveAuto-archive interval in minutes (0 means the maximum interval will be used)
--auto-deleteAuto-delete interval in minutes (negative value means disabled, 0 means delete immediately upon stopping)
--auto-stopAuto-stop interval in minutes (0 means disabled)
--classSandbox class type (small, medium, large)
--context-cFiles or directories to include in the build context (can be specified multiple times)
--cpuCPU cores allocated to the sandbox
--diskDisk space allocated to the sandbox in GB
--dockerfile-fPath to Dockerfile for Sandbox snapshot
--env-eEnvironment variables (format: KEY=VALUE)
--gpuGPU units allocated to the sandbox
--label-lLabels (format: KEY=VALUE)
--memoryMemory allocated to the sandbox in MB
--nameName of the sandbox
--network-allow-listComma-separated list of allowed CIDR network addresses for the sandbox
--network-block-allWhether to block all network access for the sandbox
--publicMake sandbox publicly accessible
--snapshotSnapshot to use for the sandbox
--targetTarget region (eu, us)
--userUser associated with the sandbox
--volume-vVolumes to mount (format: VOLUME_NAME:MOUNT_PATH)
--helphelp for daytona

daytona delete

Delete a sandbox

shell
daytona delete [SANDBOX_ID] | [SANDBOX_NAME] [flags]

Flags

LongShortDescription
--all-aDelete all sandboxes
--helphelp for daytona

daytona docs

Opens the Daytona documentation in your default browser.

shell
daytona docs [flags]

Flags

LongShortDescription
--helphelp for daytona

daytona exec

Execute a command in a sandbox

shell
daytona exec [SANDBOX_ID | SANDBOX_NAME] -- [COMMAND] [ARGS...] [flags]

Flags

LongShortDescription
--cwdWorking directory for command execution
--timeoutCommand timeout in seconds (0 for no timeout)
--helphelp for daytona

daytona info

Get sandbox info

shell
daytona info [SANDBOX_ID] | [SANDBOX_NAME] [flags]

Flags

LongShortDescription
--format-fOutput format. Must be one of (yaml, json)
--helphelp for daytona

daytona list

List sandboxes

shell
daytona list [flags]

Flags

LongShortDescription
--format-fOutput format. Must be one of (yaml, json)
--limit-lMaximum number of items per page
--page-pPage number for pagination (starting from 1)
--helphelp for daytona

daytona login

Log in to Daytona

shell
daytona login [flags]

Flags

LongShortDescription
--api-keyAPI key to use for authentication
--helphelp for daytona

daytona logout

Logout from Daytona

shell
daytona logout [flags]

Flags

LongShortDescription
--helphelp for daytona

daytona mcp

Manage Daytona MCP Server

shell
daytona mcp [flags]

Flags

LongShortDescription
--helphelp for daytona

daytona mcp config

Outputs JSON configuration for Daytona MCP Server

shell
daytona mcp config [AGENT_NAME] [flags]

Flags

LongShortDescription
--helphelp for daytona

daytona mcp init

Initialize Daytona MCP Server with an agent (currently supported: claude, windsurf, cursor)

shell
daytona mcp init [AGENT_NAME] [flags]

Flags

LongShortDescription
--helphelp for daytona

daytona mcp start

Start Daytona MCP Server

shell
daytona mcp start [flags]

Flags

LongShortDescription
--helphelp for daytona

daytona organization

Manage Daytona organizations

shell
daytona organization [flags]

Flags

LongShortDescription
--helphelp for daytona

daytona organization create

Create a new organization and set it as active

shell
daytona organization create [ORGANIZATION_NAME] [flags]

Flags

LongShortDescription
--helphelp for daytona

daytona organization delete

Delete an organization

shell
daytona organization delete [ORGANIZATION] [flags]

Flags

LongShortDescription
--helphelp for daytona

daytona organization list

List all organizations

shell
daytona organization list [flags]

Flags

LongShortDescription
--format-fOutput format. Must be one of (yaml, json)
--helphelp for daytona

daytona organization use

Set active organization

shell
daytona organization use [ORGANIZATION] [flags]

Flags

LongShortDescription
--helphelp for daytona

daytona preview-url

Get signed preview URL for a sandbox port

shell
daytona preview-url [SANDBOX_ID | SANDBOX_NAME] [flags]

Flags

LongShortDescription
--expiresURL expiration time in seconds
--port-pPort number to get preview URL for (required)
--helphelp for daytona

daytona snapshot

Manage Daytona snapshots

shell
daytona snapshot [flags]

Flags

LongShortDescription
--helphelp for daytona

daytona snapshot create

Create a snapshot

shell
daytona snapshot create [SNAPSHOT] [flags]

Flags

LongShortDescription
--context-cFiles or directories to include in the build context (can be specified multiple times). If not provided, context will be automatically determined from COPY/ADD commands in the Dockerfile
--cpuCPU cores that will be allocated to the underlying sandboxes (default: 1)
--diskDisk space that will be allocated to the underlying sandboxes in GB (default: 3)
--dockerfile-fPath to Dockerfile to build
--entrypoint-eThe entrypoint command for the snapshot
--image-iThe image name for the snapshot
--memoryMemory that will be allocated to the underlying sandboxes in GB (default: 1)
--regionID of the region where the snapshot will be available (defaults to organization default region)
--helphelp for daytona

daytona snapshot delete

Delete a snapshot

shell
daytona snapshot delete [SNAPSHOT_ID] [flags]

Flags

LongShortDescription
--all-aDelete all snapshots
--helphelp for daytona

daytona snapshot list

List all snapshots

shell
daytona snapshot list [flags]

Flags

LongShortDescription
--format-fOutput format. Must be one of (yaml, json)
--limit-lMaximum number of items per page
--page-pPage number for pagination (starting from 1)
--helphelp for daytona

daytona snapshot push

Push local snapshot

shell
daytona snapshot push [SNAPSHOT] [flags]

Flags

LongShortDescription
--cpuCPU cores that will be allocated to the underlying sandboxes (default: 1)
--diskDisk space that will be allocated to the underlying sandboxes in GB (default: 3)
--entrypoint-eThe entrypoint command for the image
--memoryMemory that will be allocated to the underlying sandboxes in GB (default: 1)
--name-nSpecify the Snapshot name
--regionID of the region where the snapshot will be available (defaults to organization default region)
--helphelp for daytona

daytona ssh

SSH into a sandbox

shell
daytona ssh [SANDBOX_ID] | [SANDBOX_NAME] [flags]

Flags

LongShortDescription
--expiresSSH access token expiration time in minutes (defaults to 24 hours)
--helphelp for daytona

daytona start

Start a sandbox

shell
daytona start [SANDBOX_ID] | [SANDBOX_NAME] [flags]

Flags

LongShortDescription
--helphelp for daytona

daytona stop

Stop a sandbox

shell
daytona stop [SANDBOX_ID] | [SANDBOX_NAME] [flags]

Flags

LongShortDescription
--helphelp for daytona

daytona version

Print the version number

shell
daytona version [flags]

Flags

LongShortDescription
--helphelp for daytona

daytona volume

Manage Daytona volumes

shell
daytona volume [flags]

Flags

LongShortDescription
--helphelp for daytona

daytona volume create

Create a volume

shell
daytona volume create [NAME] [flags]

Flags

LongShortDescription
--size-sSize of the volume in GB
--helphelp for daytona

daytona volume delete

Delete a volume

shell
daytona volume delete [VOLUME_ID] [flags]

Flags

LongShortDescription
--helphelp for daytona

daytona volume get

Get volume details

shell
daytona volume get [VOLUME_ID] [flags]

Flags

LongShortDescription
--format-fOutput format. Must be one of (yaml, json)
--helphelp for daytona

daytona volume list

List all volumes

shell
daytona volume list [flags]

Flags

LongShortDescription
--format-fOutput format. Must be one of (yaml, json)
--helphelp for daytona