Usage
--from:
Examples
Create a Devbox interactively
Create a named Devbox for a repository
Create a Devbox from a YAML specification
.json, .yaml, .yml, and .toml.
Read a specification from standard input
--from_format to select another format.
Options
string
Set the Devbox access mode to
private or shared. When omitted, the workspace default applies.boolean
default:"true"
Activate the Devbox immediately after creating it.
boolean
default:"false"
Include all image versions when choosing an image.
duration
Stop the Devbox after it remains idle for this duration, such as
30m or 1h.string
Create the Devbox from the latest version of the named Blueprint. This option cannot be combined with
--from or --platform.string
Check out this repository. When omitted, the workspace default repository applies. This option cannot be combined with
--no_checkout.boolean
default:"true"
Select the closest site when a site is not specified.
string
Use the specified dotfiles repository.
boolean
default:"false"
Create an ephemeral Devbox whose instance and storage are discarded when it stops.
string
Load a Devbox specification from a JSON, YAML, or TOML file. Pass
- to read from standard input.string
Force the
--from input format to json, yaml, or toml instead of inferring it from the filename. Standard input defaults to YAML.string
Use an image name or reference. When omitted, the CLI prompts for an image. This option cannot be combined with
--image_ref.string
Use an exact image reference. This option cannot be combined with
--image.string
Set the Devbox name and skip the name prompt.
boolean
default:"false"
Skip repository checkout, including the workspace default. This option cannot be combined with
--checkout.boolean
default:"true"
Enable persistent storage.
string
Select
linux, linux/amd64, macos, or macos/arm64. --machine_type is an alias. This option cannot be combined with --from or --blueprint.strings
Enable one or more private feature IDs for the Devbox.
string
Attach a free-form description of the Devbox’s purpose.
boolean
default:"false"
Configure
gh and Git authentication in the Devbox from the local GitHub token. Requires activation.string
Create the Devbox at the specified site.
string
Select
s, m, l, or xl for Linux, or m or l for macOS. When omitted, the CLI prompts for a size.int
Set the persistent volume size in GiB. When omitted, the workspace default applies.
Related topics
Managing Devboxes
Configure Devboxes and see the specification file reference.
Blueprints
Define reusable Devbox configurations.
Custom images
Build images for use with
--image.