Plugin for the Twilio CLI to locally develop, debug and deploy to Twilio Serverless. Part of the Serverless Toolkit
This plugin adds functionality to the Twilio CLI to locally develop, debug and deploy to Twilio Serverless. It's a part of the Serverless Toolkit and wraps twilio-run and create-twilio-function.
Important: This version requires Twilio CLI version 3.0 or newer. For Twilio CLI version 2.x you have to use plugin-serverless version 2.4.
Via npm or yarn:
$ npm install -g twilio-cli
$ yarn global add twilio-cliVia homebrew:
$ brew tap twilio/brew && brew install twilio$ twilio plugins:install @twilio-labs/plugin-serverless
$ twilio --help serverless
USAGE
$ twilio serverless
...When deploying lots of Functions and Assets it is possible to run up against the enforced concurrency limits of the Twilio API. You can limit the concurrency and set how many times the library retries API requests using environment variables. It is advisable to keep the concurrency low (around 10-15) to avoid hitting the rate limits of the Twilio API. The default concurrency is 10 and the default number of retries is 10. You can change this by setting environment variables. The following would set concurrency to 1, only 1 live request at a time, and retries to 0, so if it fails it won't retry.
export TWILIO_SERVERLESS_API_CONCURRENCY=1
export TWILIO_SERVERLESS_API_RETRY_LIMIT=0twilio serverless:activatetwilio serverless:deploytwilio serverless:dev [DIR]twilio serverless:env:gettwilio serverless:env:importtwilio serverless:env:listtwilio serverless:env:settwilio serverless:env:unsettwilio serverless:init NAMEtwilio serverless:list [TYPES]twilio serverless:list-templatestwilio serverless:logstwilio serverless:new [NAMESPACE]twilio serverless:promotetwilio serverless:run [DIR]twilio serverless:start [DIR]
Promotes an existing deployment to a new environment
USAGE
$ twilio serverless:activate [-l (debug|info|warn|error|none)] [-o (columns|json|tsv|none)] [--silent] [-p <value>] [-l
<value>] [-c <value>] [--cwd <value>] [--env <value>] [-u <value>] [--password <value>] [--load-system-env]
[--service-sid <value>] [--build-sid <value>] [--from-build <value>] [--source-environment <value>] [--from <value>]
[--environment <value>] [--to <value>] [--production] [--create-environment] [--force] [-o <value>]
FLAGS
-c, --config=<value> Location of the config file. Absolute path or relative to current working directory
(cwd)
-l=(debug|info|warn|error|none) [default: info] Level of logging messages.
-l, --log-level=<value> [default: info] Level of logging messages.
-o=(columns|json|tsv|none) [default: columns] Format of command output.
-o, --output-format=<value> Output the results in a different format
-p, --profile=<value> Shorthand identifier for your profile.
-u, --username=<value> A specific API key or account SID to be used for deployment. Uses fields in .env
otherwise
--build-sid=<value> An existing Build SID to deploy to the new environment
--create-environment Creates environment if it couldn't find it.
--cwd=<value> Sets the directory of your existing Serverless project. Defaults to current
directory
--env=<value> Path to .env file for environment variables that should be installed
--environment=<value> [default: dev] The environment name (domain suffix) you want to use for your
deployment. Alternatively you can specify an environment SID starting with ZE.
--force Will run deployment in force mode. Can be dangerous.
--from=<value> [Alias for "source-environment"]
--from-build=<value> [Alias for "build-sid"]
--load-system-env Uses system environment variables as fallback for variables specified in your .env
file. Needs to be used with --env explicitly specified.
--password=<value> A specific API secret or auth token for deployment. Uses fields from .env otherwise
--production Promote build to the production environment (no domain suffix). Overrides
environment flag
--service-sid=<value> SID of the Twilio Serverless Service to deploy to
--silent Suppress output and logs. This is a shorthand for "-l none -o none".
--source-environment=<value> SID or suffix of an existing environment you want to deploy from.
--to=<value> [Alias for "environment"]
DESCRIPTION
Promotes an existing deployment to a new environment
ALIASES
$ twilio serverless:activate
Deploys existing functions and assets to Twilio
USAGE
$ twilio serverless:deploy [-l (debug|info|warn|error|none)] [-o (columns|json|tsv|none)] [--silent] [-p <value>] [-l
<value>] [-c <value>] [--cwd <value>] [--env <value>] [-u <value>] [--password <value>] [--load-system-env]
[--service-sid <value>] [--environment <value>] [--to <value>] [-n <value>] [--override-existing-project] [--force]
[--functions] [--assets] [--assets-folder <value>] [--functions-folder <value>] [--runtime <value>] [-o <value>]
[--production]
FLAGS
-c, --config=<value> Location of the config file. Absolute path or relative to current working directory
(cwd)
-l=(debug|info|warn|error|none) [default: info] Level of logging messages.
-l, --log-level=<value> [default: info] Level of logging messages.
-n, --service-name=<value> Overrides the name of the Serverless project. Default: the name field in your
package.json
-o=(columns|json|tsv|none) [default: columns] Format of command output.
-o, --output-format=<value> Output the results in a different format
-p, --profile=<value> Shorthand identifier for your profile.
-u, --username=<value> A specific API key or account SID to be used for deployment. Uses fields in .env
otherwise
--[no-]assets Upload assets. Can be turned off with --no-assets
--assets-folder=<value> Specific folder name to be used for static assets
--cwd=<value> Sets the directory of your existing Serverless project. Defaults to current directory
--env=<value> Path to .env file for environment variables that should be installed
--environment=<value> [default: dev] The environment name (domain suffix) you want to use for your
deployment. Alternatively you can specify an environment SID starting with ZE.
--force Will run deployment in force mode. Can be dangerous.
--[no-]functions Upload functions. Can be turned off with --no-functions
--functions-folder=<value> Specific folder name to be used for static functions
--load-system-env Uses system environment variables as fallback for variables specified in your .env
file. Needs to be used with --env explicitly specified.
--override-existing-project Deploys Serverless project to existing service if a naming conflict has been found.
--password=<value> A specific API secret or auth token for deployment. Uses fields from .env otherwise
--production Please prefer the "activate" command! Deploys to the production environment (no
domain suffix). Overrides the value passed via the environment flag.
--runtime=<value> The version of Node.js to deploy the build to. (node18)
--service-sid=<value> SID of the Twilio Serverless Service to deploy to
--silent Suppress output and logs. This is a shorthand for "-l none -o none".
--to=<value> [Alias for "environment"]
DESCRIPTION
Deploys existing functions and assets to Twilio
See code: src/commands/serverless/deploy.js
Starts local Twilio Functions development server
USAGE
$ twilio serverless:dev [DIR] -p <value> [-l <value>] [-c <value>] [--cwd <value>] [--env <value>] [-f] [--ngrok
<value>] [--logs] [--detailed-logs] [--live] [--inspect <value>] [--inspect-brk <value>] [--legacy-mode]
[--assets-folder <value>] [--functions-folder <value>] [--fork-process]
ARGUMENTS
DIR Root directory to serve local Functions/Assets from
FLAGS
-c, --config=<value> Location of the config file. Absolute path or relative to current working directory
(cwd)
-f, --load-local-env Includes the local environment variables
-l, --log-level=<value> [default: info] Level of logging messages.
-p, --port=<value> (required) [default: 3000] Override default port of 3000
--assets-folder=<value> Specific folder name to be used for static assets
--cwd=<value> Alternative way to define the directory to start the server in. Overrides the [dir]
argument passed.
--detailed-logs Toggles detailed request logging by showing request body and query params
--env=<value> Path to .env file for environment variables that should be installed
--[no-]fork-process Disable forking function processes to emulate production environment
--functions-folder=<value> Specific folder name to be used for static functions
--inspect=<value> Enables Node.js debugging protocol
--inspect-brk=<value> Enables Node.js debugging protocol, stops execution until debugger is attached
--legacy-mode Enables legacy mode, it will prefix your asset paths with /assets
--[no-]live Always serve from the current functions (no caching)
--[no-]logs Toggles request logging
--ngrok=<value> Uses ngrok to create a public url. Pass a string to set the subdomain (requires a
paid-for ngrok account).
DESCRIPTION
Starts local Twilio Functions development server
ALIASES
$ twilio serverless:dev
$ twilio serverless:run
Retrieves the value of a specific environment variable
USAGE
$ twilio serverless:env:get [-l (debug|info|warn|error|none)] [-o (columns|json|tsv|none)] [--silent] [-p <value>] [-l
<value>] [-c <value>] [--cwd <value>] [--env <value>] [-u <value>] [--password <value>] [--load-system-env]
[--service-sid <value>] [--environment <value>] [--to <value>] [--key <value>] [--production]
FLAGS
-c, --config=<value> Location of the config file. Absolute path or relative to current working directory
(cwd)
-l=(debug|info|warn|error|none) [default: info] Level of logging messages.
-l, --log-level=<value> [default: info] Level of logging messages.
-o=(columns|json|tsv|none) [default: columns] Format of command output.
-p, --profile=<value> Shorthand identifier for your profile.
-u, --username=<value> A specific API key or account SID to be used for deployment. Uses fields in .env
otherwise
--cwd=<value> Sets the directory of your existing Serverless project. Defaults to current directory
--env=<value> Path to .env file for environment variables that should be installed
--environment=<value> [default: dev] The environment name (domain suffix) you want to use for your
deployment. Alternatively you can specify an environment SID starting with ZE.
--key=<value> Name of the environment variable
--load-system-env Uses system environment variables as fallback for variables specified in your .env
file. Needs to be used with --env explicitly specified.
--password=<value> A specific API secret or auth token for deployment. Uses fields from .env otherwise
--production Promote build to the production environment (no domain suffix). Overrides environment
flag
--service-sid=<value> SID of the Twilio Serverless Service to deploy to
--silent Suppress output and logs. This is a shorthand for "-l none -o none".
--to=<value> [Alias for "environment"]
DESCRIPTION
Retrieves the value of a specific environment variable
See code: src/commands/serverless/env/get.js
Takes a .env file and uploads all environment variables to a given environment
USAGE
$ twilio serverless:env:import [-l (debug|info|warn|error|none)] [-o (columns|json|tsv|none)] [--silent] [-p <value>] [-l
<value>] [-c <value>] [--cwd <value>] [--env <value>] [-u <value>] [--password <value>] [--load-system-env]
[--service-sid <value>] [--environment <value>] [--to <value>] [--production]
FLAGS
-c, --config=<value> Location of the config file. Absolute path or relative to current working directory
(cwd)
-l=(debug|info|warn|error|none) [default: info] Level of logging messages.
-l, --log-level=<value> [default: info] Level of logging messages.
-o=(columns|json|tsv|none) [default: columns] Format of command output.
-p, --profile=<value> Shorthand identifier for your profile.
-u, --username=<value> A specific API key or account SID to be used for deployment. Uses fields in .env
otherwise
--cwd=<value> Sets the directory of your existing Serverless project. Defaults to current directory
--env=<value> Path to .env file for environment variables that should be installed
--environment=<value> [default: dev] The environment name (domain suffix) you want to use for your
deployment. Alternatively you can specify an environment SID starting with ZE.
--load-system-env Uses system environment variables as fallback for variables specified in your .env
file. Needs to be used with --env explicitly specified.
--password=<value> A specific API secret or auth token for deployment. Uses fields from .env otherwise
--production Promote build to the production environment (no domain suffix). Overrides environment
flag
--service-sid=<value> SID of the Twilio Serverless Service to deploy to
--silent Suppress output and logs. This is a shorthand for "-l none -o none".
--to=<value> [Alias for "environment"]
DESCRIPTION
Takes a .env file and uploads all environment variables to a given environment
See code: src/commands/serverless/env/import.js
Lists all environment variables for a given environment
USAGE
$ twilio serverless:env:list [-l (debug|info|warn|error|none)] [-o (columns|json|tsv|none)] [--silent] [-p <value>] [-l
<value>] [-c <value>] [--cwd <value>] [--env <value>] [-u <value>] [--password <value>] [--load-system-env]
[--service-sid <value>] [--environment <value>] [--to <value>] [--show-values] [--production] [-o <value>]
FLAGS
-c, --config=<value> Location of the config file. Absolute path or relative to current working directory
(cwd)
-l=(debug|info|warn|error|none) [default: info] Level of logging messages.
-l, --log-level=<value> [default: info] Level of logging messages.
-o=(columns|json|tsv|none) [default: columns] Format of command output.
-o, --output-format=<value> Output the results in a different format
-p, --profile=<value> Shorthand identifier for your profile.
-u, --username=<value> A specific API key or account SID to be used for deployment. Uses fields in .env
otherwise
--cwd=<value> Sets the directory of your existing Serverless project. Defaults to current directory
--env=<value> Path to .env file for environment variables that should be installed
--environment=<value> [default: dev] The environment name (domain suffix) you want to use for your
deployment. Alternatively you can specify an environment SID starting with ZE.
--load-system-env Uses system environment variables as fallback for variables specified in your .env
file. Needs to be used with --env explicitly specified.
--password=<value> A specific API secret or auth token for deployment. Uses fields from .env otherwise
--production Promote build to the production environment (no domain suffix). Overrides environment
flag
--service-sid=<value> SID of the Twilio Serverless Service to deploy to
--show-values Show the values of your environment variables
--silent Suppress output and logs. This is a shorthand for "-l none -o none".
--to=<value> [Alias for "environment"]
DESCRIPTION
Lists all environment variables for a given environment
See code: src/commands/serverless/env/list.js
Sets an environment variable with a given key and value
USAGE
$ twilio serverless:env:set [-l (debug|info|warn|error|none)] [-o (columns|json|tsv|none)] [--silent] [-p <value>] [-l
<value>] [-c <value>] [--cwd <value>] [--env <value>] [-u <value>] [--password <value>] [--load-system-env]
[--service-sid <value>] [--environment <value>] [--to <value>] [--key <value>] [--value <value>] [--production]
FLAGS
-c, --config=<value> Location of the config file. Absolute path or relative to current working directory
(cwd)
-l=(debug|info|warn|error|none) [default: info] Level of logging messages.
-l, --log-level=<value> [default: info] Level of logging messages.
-o=(columns|json|tsv|none) [default: columns] Format of command output.
-p, --profile=<value> Shorthand identifier for your profile.
-u, --username=<value> A specific API key or account SID to be used for deployment. Uses fields in .env
otherwise
--cwd=<value> Sets the directory of your existing Serverless project. Defaults to current directory
--env=<value> Path to .env file for environment variables that should be installed
--environment=<value> [default: dev] The environment name (domain suffix) you want to use for your
deployment. Alternatively you can specify an environment SID starting with ZE.
--key=<value> Name of the environment variable
--load-system-env Uses system environment variables as fallback for variables specified in your .env
file. Needs to be used with --env explicitly specified.
--password=<value> A specific API secret or auth token for deployment. Uses fields from .env otherwise
--production Promote build to the production environment (no domain suffix). Overrides environment
flag
--service-sid=<value> SID of the Twilio Serverless Service to deploy to
--silent Suppress output and logs. This is a shorthand for "-l none -o none".
--to=<value> [Alias for "environment"]
--value=<value> Name of the environment variable
DESCRIPTION
Sets an environment variable with a given key and value
See code: src/commands/serverless/env/set.js
Removes an environment variable for a given key
USAGE
$ twilio serverless:env:unset [-l (debug|info|warn|error|none)] [-o (columns|json|tsv|none)] [--silent] [-p <value>] [-l
<value>] [-c <value>] [--cwd <value>] [--env <value>] [-u <value>] [--password <value>] [--load-system-env]
[--service-sid <value>] [--environment <value>] [--to <value>] [--key <value>] [--production]
FLAGS
-c, --config=<value> Location of the config file. Absolute path or relative to current working directory
(cwd)
-l=(debug|info|warn|error|none) [default: info] Level of logging messages.
-l, --log-level=<value> [default: info] Level of logging messages.
-o=(columns|json|tsv|none) [default: columns] Format of command output.
-p, --profile=<value> Shorthand identifier for your profile.
-u, --username=<value> A specific API key or account SID to be used for deployment. Uses fields in .env
otherwise
--cwd=<value> Sets the directory of your existing Serverless project. Defaults to current directory
--env=<value> Path to .env file for environment variables that should be installed
--environment=<value> [default: dev] The environment name (domain suffix) you want to use for your
deployment. Alternatively you can specify an environment SID starting with ZE.
--key=<value> Name of the environment variable
--load-system-env Uses system environment variables as fallback for variables specified in your .env
file. Needs to be used with --env explicitly specified.
--password=<value> A specific API secret or auth token for deployment. Uses fields from .env otherwise
--production Promote build to the production environment (no domain suffix). Overrides environment
flag
--service-sid=<value> SID of the Twilio Serverless Service to deploy to
--silent Suppress output and logs. This is a shorthand for "-l none -o none".
--to=<value> [Alias for "environment"]
DESCRIPTION
Removes an environment variable for a given key
See code: src/commands/serverless/env/unset.js
Creates a new Twilio Function project
USAGE
$ twilio serverless:init NAME [-l (debug|info|warn|error|none)] [-o (columns|json|tsv|none)] [--silent] [-p
<value>] [-a <value>] [-t <value>] [--skip-credentials] [--import-credentials] [--template <value>] [--empty]
[--typescript]
ARGUMENTS
NAME Name of Serverless project and directory that will be created
FLAGS
-a, --account-sid=<value> The Account SID for your Twilio account
-l=(debug|info|warn|error|none) [default: info] Level of logging messages.
-o=(columns|json|tsv|none) [default: columns] Format of command output.
-p, --profile=<value> Shorthand identifier for your profile.
-t, --auth-token=<value> Your Twilio account Auth Token
--empty Initialize your new project with empty functions and assets directories
--import-credentials Import credentials from the environment variables TWILIO_ACCOUNT_SID and
TWILIO_AUTH_TOKEN
--silent Suppress output and logs. This is a shorthand for "-l none -o none".
--skip-credentials Don't ask for Twilio account credentials or import them from the environment
--template=<value> Initialize your new project with a template from
github.com/twilio-labs/function-templates
--typescript Initialize your Serverless project with TypeScript
DESCRIPTION
Creates a new Twilio Function project
See code: src/commands/serverless/init.js
List existing services, environments, variables, deployments for your Twilio Serverless Account
USAGE
$ twilio serverless:list [TYPES] [-l (debug|info|warn|error|none)] [-o (columns|json|tsv|none)] [--silent] [-p
<value>] [-l <value>] [-c <value>] [--cwd <value>] [--env <value>] [-u <value>] [--password <value>]
[--load-system-env] [-n <value>] [--extended-output] [--service-sid <value>] [-o <value>] [--environment <value>]
[--to <value>]
ARGUMENTS
TYPES [default: services] Comma separated list of things to list (services,environments,functions,assets,variables)
FLAGS
-c, --config=<value> Location of the config file. Absolute path or relative to current working directory
(cwd)
-l=(debug|info|warn|error|none) [default: info] Level of logging messages.
-l, --log-level=<value> [default: info] Level of logging messages.
-n, --service-name=<value> Overrides the name of the Serverless project. Default: the name field in your
package.json
-o=(columns|json|tsv|none) [default: columns] Format of command output.
-o, --output-format=<value> Output the results in a different format
-p, --profile=<value> Shorthand identifier for your profile.
-u, --username=<value> A specific API key or account SID to be used for deployment. Uses fields in .env
otherwise
--cwd=<value> Sets the directory of your existing Serverless project. Defaults to current directory
--env=<value> Path to .env file for environment variables that should be installed
--environment=<value> [default: dev] The environment to list variables for
--extended-output Show an extended set of properties on the output
--load-system-env Uses system environment variables as fallback for variables specified in your .env
file. Needs to be used with --env explicitly specified.
--password=<value> A specific API secret or auth token for deployment. Uses fields from .env otherwise
--service-sid=<value> SID of the Twilio Serverless Service to deploy to
--silent Suppress output and logs. This is a shorthand for "-l none -o none".
--to=<value> [Alias for "environment"]
DESCRIPTION
List existing services, environments, variables, deployments for your Twilio Serverless Account
See code: src/commands/serverless/list.js
Lists the available Twilio Function templates
USAGE
$ twilio serverless:list-templates [-o <value>]
FLAGS
-o, --output-format=<value> Output the results in a different format
DESCRIPTION
Lists the available Twilio Function templates
See code: src/commands/serverless/list-templates.js
Print logs from your Twilio Serverless project
USAGE
$ twilio serverless:logs [-l (debug|info|warn|error|none)] [-o (columns|json|tsv|none)] [--silent] [-p <value>] [-l
<value>] [-c <value>] [--cwd <value>] [--env <value>] [-u <value>] [--password <value>] [--load-system-env]
[--service-sid <value>] [--function-sid <value>] [--tail] [-o <value>] [--production] [--environment <value>] [--to
<value>]
FLAGS
-c, --config=<value> Location of the config file. Absolute path or relative to current working directory
(cwd)
-l=(debug|info|warn|error|none) [default: info] Level of logging messages.
-l, --log-level=<value> [default: info] Level of logging messages.
-o=(columns|json|tsv|none) [default: columns] Format of command output.
-o, --output-format=<value> Output the results in a different format
-p, --profile=<value> Shorthand identifier for your profile.
-u, --username=<value> A specific API key or account SID to be used for deployment. Uses fields in .env
otherwise
--cwd=<value> Sets the directory of your existing Serverless project. Defaults to current directory
--env=<value> Path to .env file for environment variables that should be installed
--environment=<value> [default: dev] The environment to retrieve the logs for
--function-sid=<value> Specific Function SID to retrieve logs for
--load-system-env Uses system environment variables as fallback for variables specified in your .env
file. Needs to be used with --env explicitly specified.
--password=<value> A specific API secret or auth token for deployment. Uses fields from .env otherwise
--production Retrieve logs for the production environment. Overrides the "environment" flag
--service-sid=<value> SID of the Twilio Serverless Service to deploy to
--silent Suppress output and logs. This is a shorthand for "-l none -o none".
--tail Continuously stream the logs
--to=<value> [Alias for "environment"]
DESCRIPTION
Print logs from your Twilio Serverless project
See code: src/commands/serverless/logs.js
Creates a new Twilio Function based on an existing template
USAGE
$ twilio serverless:new [NAMESPACE] [-l <value>] [-c <value>] [--cwd <value>] [--env <value>] [--template <value>]
ARGUMENTS
NAMESPACE The namespace your assets/functions should be grouped under
FLAGS
-c, --config=<value> Location of the config file. Absolute path or relative to current working directory (cwd)
-l, --log-level=<value> [default: info] Level of logging messages.
--cwd=<value> Sets the directory of your existing Serverless project. Defaults to current directory
--env=<value> Path to .env file for environment variables that should be installed
--template=<value>
DESCRIPTION
Creates a new Twilio Function based on an existing template
See code: src/commands/serverless/new.js
Promotes an existing deployment to a new environment
USAGE
$ twilio serverless:promote [-l (debug|info|warn|error|none)] [-o (columns|json|tsv|none)] [--silent] [-p <value>] [-l
<value>] [-c <value>] [--cwd <value>] [--env <value>] [-u <value>] [--password <value>] [--load-system-env]
[--service-sid <value>] [--build-sid <value>] [--from-build <value>] [--source-environment <value>] [--from <value>]
[--environment <value>] [--to <value>] [--production] [--create-environment] [--force] [-o <value>]
FLAGS
-c, --config=<value> Location of the config file. Absolute path or relative to current working directory
(cwd)
-l=(debug|info|warn|error|none) [default: info] Level of logging messages.
-l, --log-level=<value> [default: info] Level of logging messages.
-o=(columns|json|tsv|none) [default: columns] Format of command output.
-o, --output-format=<value> Output the results in a different format
-p, --profile=<value> Shorthand identifier for your profile.
-u, --username=<value> A specific API key or account SID to be used for deployment. Uses fields in .env
otherwise
--build-sid=<value> An existing Build SID to deploy to the new environment
--create-environment Creates environment if it couldn't find it.
--cwd=<value> Sets the directory of your existing Serverless project. Defaults to current
directory
--env=<value> Path to .env file for environment variables that should be installed
--environment=<value> [default: dev] The environment name (domain suffix) you want to use for your
deployment. Alternatively you can specify an environment SID starting with ZE.
--force Will run deployment in force mode. Can be dangerous.
--from=<value> [Alias for "source-environment"]
--from-build=<value> [Alias for "build-sid"]
--load-system-env Uses system environment variables as fallback for variables specified in your .env
file. Needs to be used with --env explicitly specified.
--password=<value> A specific API secret or auth token for deployment. Uses fields from .env otherwise
--production Promote build to the production environment (no domain suffix). Overrides
environment flag
--service-sid=<value> SID of the Twilio Serverless Service to deploy to
--silent Suppress output and logs. This is a shorthand for "-l none -o none".
--source-environment=<value> SID or suffix of an existing environment you want to deploy from.
--to=<value> [Alias for "environment"]
DESCRIPTION
Promotes an existing deployment to a new environment
ALIASES
$ twilio serverless:activate
See code: src/commands/serverless/promote.js
Starts local Twilio Functions development server
USAGE
$ twilio serverless:run [DIR] -p <value> [-l <value>] [-c <value>] [--cwd <value>] [--env <value>] [-f] [--ngrok
<value>] [--logs] [--detailed-logs] [--live] [--inspect <value>] [--inspect-brk <value>] [--legacy-mode]
[--assets-folder <value>] [--functions-folder <value>] [--fork-process]
ARGUMENTS
DIR Root directory to serve local Functions/Assets from
FLAGS
-c, --config=<value> Location of the config file. Absolute path or relative to current working directory
(cwd)
-f, --load-local-env Includes the local environment variables
-l, --log-level=<value> [default: info] Level of logging messages.
-p, --port=<value> (required) [default: 3000] Override default port of 3000
--assets-folder=<value> Specific folder name to be used for static assets
--cwd=<value> Alternative way to define the directory to start the server in. Overrides the [dir]
argument passed.
--detailed-logs Toggles detailed request logging by showing request body and query params
--env=<value> Path to .env file for environment variables that should be installed
--[no-]fork-process Disable forking function processes to emulate production environment
--functions-folder=<value> Specific folder name to be used for static functions
--inspect=<value> Enables Node.js debugging protocol
--inspect-brk=<value> Enables Node.js debugging protocol, stops execution until debugger is attached
--legacy-mode Enables legacy mode, it will prefix your asset paths with /assets
--[no-]live Always serve from the current functions (no caching)
--[no-]logs Toggles request logging
--ngrok=<value> Uses ngrok to create a public url. Pass a string to set the subdomain (requires a
paid-for ngrok account).
DESCRIPTION
Starts local Twilio Functions development server
ALIASES
$ twilio serverless:dev
$ twilio serverless:run
Starts local Twilio Functions development server
USAGE
$ twilio serverless:start [DIR] -p <value> [-l <value>] [-c <value>] [--cwd <value>] [--env <value>] [-f] [--ngrok
<value>] [--logs] [--detailed-logs] [--live] [--inspect <value>] [--inspect-brk <value>] [--legacy-mode]
[--assets-folder <value>] [--functions-folder <value>] [--fork-process]
ARGUMENTS
DIR Root directory to serve local Functions/Assets from
FLAGS
-c, --config=<value> Location of the config file. Absolute path or relative to current working directory
(cwd)
-f, --load-local-env Includes the local environment variables
-l, --log-level=<value> [default: info] Level of logging messages.
-p, --port=<value> (required) [default: 3000] Override default port of 3000
--assets-folder=<value> Specific folder name to be used for static assets
--cwd=<value> Alternative way to define the directory to start the server in. Overrides the [dir]
argument passed.
--detailed-logs Toggles detailed request logging by showing request body and query params
--env=<value> Path to .env file for environment variables that should be installed
--[no-]fork-process Disable forking function processes to emulate production environment
--functions-folder=<value> Specific folder name to be used for static functions
--inspect=<value> Enables Node.js debugging protocol
--inspect-brk=<value> Enables Node.js debugging protocol, stops execution until debugger is attached
--legacy-mode Enables legacy mode, it will prefix your asset paths with /assets
--[no-]live Always serve from the current functions (no caching)
--[no-]logs Toggles request logging
--ngrok=<value> Uses ngrok to create a public url. Pass a string to set the subdomain (requires a
paid-for ngrok account).
DESCRIPTION
Starts local Twilio Functions development server
ALIASES
$ twilio serverless:dev
$ twilio serverless:run
See code: src/commands/serverless/start.js
This project welcomes contributions from the community. Please see the CONTRIBUTING.md file for more details.
Please be aware that this project has a Code of Conduct. The tldr; is to just be excellent to each other ❤️
Thanks goes to these wonderful people (emoji key):
 Dominik Kundel 💻 📖 🤔 |
 childish-sambino 💻 🐛 |
 Elmer Thomas 🐛 📖 |
This project follows the all-contributors specification. Contributions of any kind welcome!
MIT