doctl sandbox

Go to Navigation


sbx, serverless, sls


The doctl sandbox commands provide a development sandbox for functions. A sandbox has a local file system component and a cloud component. A one-time install of the sandbox software is needed (use doctl sandbox install to install the software, then doctl sandbox connect to connect to the cloud component of the sandbox provided with your account). Other doctl sandbox commands are used to develop and test.


Option Description
--help , -h Help for this command
Command Description
doctl doctl is a command line interface (CLI) for the DigitalOcean API.
doctl sandbox activations Work with activation records
doctl sandbox connect Connect the cloud portion of your sandbox
doctl sandbox deploy Deploy sandbox local assets to the cloud
doctl sandbox functions Work with the functions of your sandbox
doctl sandbox get-metadata Obtain metadata of a sandbox directory
doctl sandbox init Initialize a local file system directory for the sandbox
doctl sandbox install Installs the sandbox support
doctl sandbox status Provide information about your sandbox
doctl sandbox undeploy Removes resources from the cloud portion of your sandbox
doctl sandbox uninstall Removes the sandbox support
doctl sandbox upgrade Upgrades sandbox support to match this version of doctl
doctl sandbox watch Watch a sandbox directory, deploying incrementally on change

Global Flags

Option Description
--access-token, -t API V2 access token
--api-url, -u Override default API endpoint
--config, -c Specify a custom config file
  • macOS: ${HOME}/Library/Application Support/doctl/config.yaml
  • Linux: ${XDG_CONFIG_HOME}/doctl/config.yaml
  • Windows: %APPDATA%\doctl\config.yaml
--context Specify a custom authentication context name
--output, -o Desired output format [text|json]
Default: text
--trace Show a log of network activity while performing a command
Default: false
--verbose, -v Enable verbose output
Default: false