doctl serverless

Go to Navigation


sandbox, sbx, sls


The doctl serverless commands provide an environment for developing, testing, and deploying serverless functions. One or more local file system areas are employed, along with one or more ‘functions namespaces’ in the cloud. A one-time install of the serverless software is needed (use doctl serverless install to install the software, then doctl serverless connect to connect to a functions namespace associated with your account). Other doctl serverless commands are used to develop, test, and deploy.


Option Description
--help , -h Help for this command
Command Description
doctl doctl is a command line interface (CLI) for the DigitalOcean API.
doctl serverless activations Retrieve activation records
doctl serverless connect Connects local serverless support to a functions namespace
doctl serverless deploy Deploy a functions project to your functions namespace
doctl serverless functions Work with the functions in your namespace
doctl serverless get-metadata Obtain metadata of a functions project
doctl serverless init Initialize a 'functions project' directory in your local file system
doctl serverless install Installs the serverless support
doctl serverless namespaces Manage your functions namespaces
doctl serverless status Provide information about serverless support
doctl serverless undeploy Removes resources from your functions namespace
doctl serverless uninstall Removes the serverless support
doctl serverless upgrade Upgrades serverless support to match this version of doctl
doctl serverless watch Watch a functions project 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
--http-retry-max Set maximum number of retries for requests that fail with a 429 or 500-level error
Default: 5
--http-retry-wait-max Set the minimum number of seconds to wait before retrying a failed request
Default: 30
--http-retry-wait-min Set the maximum number of seconds to wait before retrying a failed request
Default: 1
--interactive Enable interactive behavior. Defaults to true if the terminal supports it (default false)
Default: false
--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