@twilio-labs/plugin-serverless

Plugin for the Twilio CLI to locally develop, debug and deploy to Twilio Serverless. Part of the Serverless Toolkit

npm npm GitHub

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.

Requirements

$3

Via npm or yarn:

``sh-session $ npm install -g twilio-cli $ yarn global add twilio-cli`

Via homebrew:

`sh-session $ brew tap twilio/brew && brew install twilio`

`Usage`

`sh-session $ twilio plugins:install @twilio-labs/plugin-serverless $ twilio --help serverless USAGE $ twilio serverless ...`

`$3`

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.

`sh-session export TWILIO_SERVERLESS_API_CONCURRENCY=1 export TWILIO_SERVERLESS_API_RETRY_LIMIT=0`

`Commands`

*twilio serverless:activate*twilio serverless:deploy* [twilio serverless:dev [DIR]](#twilio-serverlessdev-dir) *twilio serverless:env:get*twilio serverless:env:import*twilio serverless:env:list*twilio serverless:env:set*twilio serverless:env:unset*twilio serverless:init NAME* [twilio serverless:list [TYPES]](#twilio-serverlesslist-types) *twilio serverless:list-templates*twilio serverless:logs* [twilio serverless:new [NAMESPACE]](#twilio-serverlessnew-namespace) *twilio serverless:promote* [twilio serverless:run [DIR]](#twilio-serverlessrun-dir) * [twilio serverless:start [DIR]](#twilio-serverlessstart-dir)

twilio serverless:activate

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 ] [-l ] [-c ] [--cwd ] [--env ] [-u ] [--password ] [--load-system-env] [--service-sid ] [--build-sid ] [--from-build ] [--source-environment ] [--from ] [--environment ] [--to ] [--production] [--create-environment] [--force] [-o ]

FLAGS -c, --config= 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= [default: info] Level of logging messages. -o=(columns|json|tsv|none) [default: columns] Format of command output. -o, --output-format= Output the results in a different format -p, --profile= Shorthand identifier for your profile. -u, --username= A specific API key or account SID to be used for deployment. Uses fields in .env otherwise --build-sid= An existing Build SID to deploy to the new environment --create-environment Creates environment if it couldn't find it. --cwd= Sets the directory of your existing Serverless project. Defaults to current directory --env= Path to .env file for environment variables that should be installed --environment= [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= [Alias for "source-environment"] --from-build= [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= 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= 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= SID or suffix of an existing environment you want to deploy from. --to= [Alias for "environment"]

DESCRIPTION Promotes an existing deployment to a new environment

ALIASES $ twilio serverless:activate`

twilio serverless:deploy

Deploys existing functions and assets to Twilio

`USAGE $ twilio serverless:deploy [-l (debug|info|warn|error|none)] [-o (columns|json|tsv|none)] [--silent] [-p ] [-l ] [-c ] [--cwd ] [--env ] [-u ] [--password ] [--load-system-env] [--service-sid ] [--environment ] [--to ] [-n ] [--override-existing-project] [--force] [--functions] [--assets] [--assets-folder ] [--functions-folder ] [--runtime ] [-o ] [--production]

FLAGS -c, --config= 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= [default: info] Level of logging messages. -n, --service-name= 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= Output the results in a different format -p, --profile= Shorthand identifier for your profile. -u, --username= 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= Specific folder name to be used for static assets --cwd= Sets the directory of your existing Serverless project. Defaults to current directory --env= Path to .env file for environment variables that should be installed --environment= [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= 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= 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= The version of Node.js to deploy the build to. (node22) --service-sid= SID of the Twilio Serverless Service to deploy to --silent Suppress output and logs. This is a shorthand for "-l none -o none". --to= [Alias for "environment"]

DESCRIPTION Deploys existing functions and assets to Twilio`

_See code: src/commands/serverless/deploy.js_

twilio serverless:dev [DIR]

Starts local Twilio Functions development server

`USAGE $ twilio serverless:dev [DIR] -p [-l ] [-c ] [--cwd ] [--env ] [-f] [--ngrok ] [--logs] [--detailed-logs] [--live] [--inspect ] [--inspect-brk ] [--legacy-mode] [--assets-folder ] [--functions-folder ] [--fork-process]

ARGUMENTS [DIR] Root directory to serve local Functions/Assets from

FLAGS -c, --config= 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= [default: info] Level of logging messages. -p, --port= (required) [default: 3000] Override default port of 3000 --assets-folder= Specific folder name to be used for static assets --cwd= 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= Path to .env file for environment variables that should be installed --[no-]fork-process Disable forking function processes to emulate production environment --functions-folder= Specific folder name to be used for static functions --inspect= Enables Node.js debugging protocol --inspect-brk= 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= 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`

twilio serverless:env:get

Retrieves the value of a specific environment variable

FLAGS -c, --config= 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= [default: info] Level of logging messages. -o=(columns|json|tsv|none) [default: columns] Format of command output. -p, --profile= Shorthand identifier for your profile. -u, --username= A specific API key or account SID to be used for deployment. Uses fields in .env otherwise --cwd= Sets the directory of your existing Serverless project. Defaults to current directory --env= Path to .env file for environment variables that should be installed --environment= [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= 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= 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= SID of the Twilio Serverless Service to deploy to --silent Suppress output and logs. This is a shorthand for "-l none -o none". --to= [Alias for "environment"]

DESCRIPTION Retrieves the value of a specific environment variable`

_See code: src/commands/serverless/env/get.js_

twilio serverless:env:import

Takes a .env file and uploads all environment variables to a given environment

FLAGS -c, --config= 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= [default: info] Level of logging messages. -o=(columns|json|tsv|none) [default: columns] Format of command output. -p, --profile= Shorthand identifier for your profile. -u, --username= A specific API key or account SID to be used for deployment. Uses fields in .env otherwise --cwd= Sets the directory of your existing Serverless project. Defaults to current directory --env= Path to .env file for environment variables that should be installed --environment= [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= 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= SID of the Twilio Serverless Service to deploy to --silent Suppress output and logs. This is a shorthand for "-l none -o none". --to= [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_

twilio serverless:env:list

Lists all environment variables for a given environment

FLAGS -c, --config= 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= [default: info] Level of logging messages. -o=(columns|json|tsv|none) [default: columns] Format of command output. -o, --output-format= Output the results in a different format -p, --profile= Shorthand identifier for your profile. -u, --username= A specific API key or account SID to be used for deployment. Uses fields in .env otherwise --cwd= Sets the directory of your existing Serverless project. Defaults to current directory --env= Path to .env file for environment variables that should be installed --environment= [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= 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= 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= [Alias for "environment"]

DESCRIPTION Lists all environment variables for a given environment`

_See code: src/commands/serverless/env/list.js_

twilio serverless:env:set

Sets an environment variable with a given key and value

FLAGS -c, --config= 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= [default: info] Level of logging messages. -o=(columns|json|tsv|none) [default: columns] Format of command output. -p, --profile= Shorthand identifier for your profile. -u, --username= A specific API key or account SID to be used for deployment. Uses fields in .env otherwise --cwd= Sets the directory of your existing Serverless project. Defaults to current directory --env= Path to .env file for environment variables that should be installed --environment= [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= 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= 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= SID of the Twilio Serverless Service to deploy to --silent Suppress output and logs. This is a shorthand for "-l none -o none". --to= [Alias for "environment"] --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_

twilio serverless:env:unset

Removes an environment variable for a given key

FLAGS -c, --config= 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= [default: info] Level of logging messages. -o=(columns|json|tsv|none) [default: columns] Format of command output. -p, --profile= Shorthand identifier for your profile. -u, --username= A specific API key or account SID to be used for deployment. Uses fields in .env otherwise --cwd= Sets the directory of your existing Serverless project. Defaults to current directory --env= Path to .env file for environment variables that should be installed --environment= [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= 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= 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= SID of the Twilio Serverless Service to deploy to --silent Suppress output and logs. This is a shorthand for "-l none -o none". --to= [Alias for "environment"]

DESCRIPTION Removes an environment variable for a given key`

_See code: src/commands/serverless/env/unset.js_

twilio serverless:init NAME

Creates a new Twilio Function project

ARGUMENTS NAME Name of Serverless project and directory that will be created

FLAGS -a, --account-sid= 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= Shorthand identifier for your profile. -t, --auth-token= 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= 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_

twilio serverless:list [TYPES]

List existing services, environments, variables, deployments for your Twilio Serverless Account

ARGUMENTS [TYPES] [default: services] Comma separated list of things to list (services,environments,functions,assets,variables)

DESCRIPTION List existing services, environments, variables, deployments for your Twilio Serverless Account`

_See code: src/commands/serverless/list.js_

twilio serverless:list-templates

Lists the available Twilio Function templates

`USAGE $ twilio serverless:list-templates [-o ]

FLAGS -o, --output-format= Output the results in a different format

DESCRIPTION Lists the available Twilio Function templates`

_See code: src/commands/serverless/list-templates.js_

twilio serverless:logs

Print logs from your Twilio Serverless project

FLAGS -c, --config= 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= [default: info] Level of logging messages. -o=(columns|json|tsv|none) [default: columns] Format of command output. -o, --output-format= Output the results in a different format -p, --profile= Shorthand identifier for your profile. -u, --username= A specific API key or account SID to be used for deployment. Uses fields in .env otherwise --cwd= Sets the directory of your existing Serverless project. Defaults to current directory --env= Path to .env file for environment variables that should be installed --environment= [default: dev] The environment to retrieve the logs for --function-sid= 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= 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= 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= [Alias for "environment"]

DESCRIPTION Print logs from your Twilio Serverless project`

_See code: src/commands/serverless/logs.js_

twilio serverless:new [NAMESPACE]

Creates a new Twilio Function based on an existing template

`USAGE $ twilio serverless:new [NAMESPACE] [-l ] [-c ] [--cwd ] [--env ] [--template ]

ARGUMENTS [NAMESPACE] The namespace your assets/functions should be grouped under

FLAGS -c, --config= Location of the config file. Absolute path or relative to current working directory (cwd) -l, --log-level= [default: info] Level of logging messages. --cwd= Sets the directory of your existing Serverless project. Defaults to current directory --env= Path to .env file for environment variables that should be installed --template=

DESCRIPTION Creates a new Twilio Function based on an existing template`

_See code: src/commands/serverless/new.js_

twilio serverless:promote

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 ] [-l ] [-c ] [--cwd ] [--env ] [-u ] [--password ] [--load-system-env] [--service-sid ] [--build-sid ] [--from-build ] [--source-environment ] [--from ] [--environment ] [--to ] [--production] [--create-environment] [--force] [-o ]

DESCRIPTION Promotes an existing deployment to a new environment

ALIASES $ twilio serverless:activate`

_See code: src/commands/serverless/promote.js_

twilio serverless:run [DIR]

Starts local Twilio Functions development server

`USAGE $ twilio serverless:run [DIR] -p [-l ] [-c ] [--cwd ] [--env ] [-f] [--ngrok ] [--logs] [--detailed-logs] [--live] [--inspect ] [--inspect-brk ] [--legacy-mode] [--assets-folder ] [--functions-folder ] [--fork-process]

ARGUMENTS [DIR] Root directory to serve local Functions/Assets from

DESCRIPTION Starts local Twilio Functions development server

ALIASES $ twilio serverless:dev $ twilio serverless:run`

twilio serverless:start [DIR]

Starts local Twilio Functions development server

`USAGE $ twilio serverless:start [DIR] -p [-l ] [-c ] [--cwd ] [--env ] [-f] [--ngrok ] [--logs] [--detailed-logs] [--live] [--inspect ] [--inspect-brk ] [--legacy-mode] [--assets-folder ] [--functions-folder ] [--fork-process]

ARGUMENTS [DIR] Root directory to serve local Functions/Assets from

DESCRIPTION Starts local Twilio Functions development server

ALIASES $ twilio serverless:dev $ twilio serverless:run`

_See code: src/commands/serverless/start.js_

`Contributing`

This project welcomes contributions from the community. Please see the CONTRIBUTING.md` file for more details.

$3

Please be aware that this project has a Code of Conduct. The tldr; is to just be excellent to each other ❤️

$3

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!

License

MIT

@twilio-labs/plugin-serverless

Plugin for the Twilio CLI to locally develop, debug and deploy to Twilio Serverless. Part of the Serverless Toolkit

npm npm GitHub

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.

Requirements

$3

Via npm or yarn:

``sh-session $ npm install -g twilio-cli $ yarn global add twilio-cli`

Via homebrew:

`sh-session $ brew tap twilio/brew && brew install twilio`

`Usage`

`sh-session $ twilio plugins:install @twilio-labs/plugin-serverless $ twilio --help serverless USAGE $ twilio serverless ...`

`$3`

`sh-session export TWILIO_SERVERLESS_API_CONCURRENCY=1 export TWILIO_SERVERLESS_API_RETRY_LIMIT=0`

`Commands`

twilio serverless:activate

Promotes an existing deployment to a new environment

DESCRIPTION Promotes an existing deployment to a new environment

ALIASES $ twilio serverless:activate`

twilio serverless:deploy

Deploys existing functions and assets to Twilio

FLAGS -c, --config= 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= [default: info] Level of logging messages. -n, --service-name= 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= Output the results in a different format -p, --profile= Shorthand identifier for your profile. -u, --username= 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= Specific folder name to be used for static assets --cwd= Sets the directory of your existing Serverless project. Defaults to current directory --env= Path to .env file for environment variables that should be installed --environment= [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= 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= 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= The version of Node.js to deploy the build to. (node22) --service-sid= SID of the Twilio Serverless Service to deploy to --silent Suppress output and logs. This is a shorthand for "-l none -o none". --to= [Alias for "environment"]

DESCRIPTION Deploys existing functions and assets to Twilio`

_See code: src/commands/serverless/deploy.js_

twilio serverless:dev [DIR]

Starts local Twilio Functions development server

ARGUMENTS [DIR] Root directory to serve local Functions/Assets from

DESCRIPTION Starts local Twilio Functions development server

ALIASES $ twilio serverless:dev $ twilio serverless:run`

twilio serverless:env:get

Retrieves the value of a specific environment variable

FLAGS -c, --config= 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= [default: info] Level of logging messages. -o=(columns|json|tsv|none) [default: columns] Format of command output. -p, --profile= Shorthand identifier for your profile. -u, --username= A specific API key or account SID to be used for deployment. Uses fields in .env otherwise --cwd= Sets the directory of your existing Serverless project. Defaults to current directory --env= Path to .env file for environment variables that should be installed --environment= [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= 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= 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= SID of the Twilio Serverless Service to deploy to --silent Suppress output and logs. This is a shorthand for "-l none -o none". --to= [Alias for "environment"]

DESCRIPTION Retrieves the value of a specific environment variable`

_See code: src/commands/serverless/env/get.js_

twilio serverless:env:import

Takes a .env file and uploads all environment variables to a given environment

FLAGS -c, --config= 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= [default: info] Level of logging messages. -o=(columns|json|tsv|none) [default: columns] Format of command output. -p, --profile= Shorthand identifier for your profile. -u, --username= A specific API key or account SID to be used for deployment. Uses fields in .env otherwise --cwd= Sets the directory of your existing Serverless project. Defaults to current directory --env= Path to .env file for environment variables that should be installed --environment= [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= 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= SID of the Twilio Serverless Service to deploy to --silent Suppress output and logs. This is a shorthand for "-l none -o none". --to= [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_

twilio serverless:env:list

Lists all environment variables for a given environment

FLAGS -c, --config= 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= [default: info] Level of logging messages. -o=(columns|json|tsv|none) [default: columns] Format of command output. -o, --output-format= Output the results in a different format -p, --profile= Shorthand identifier for your profile. -u, --username= A specific API key or account SID to be used for deployment. Uses fields in .env otherwise --cwd= Sets the directory of your existing Serverless project. Defaults to current directory --env= Path to .env file for environment variables that should be installed --environment= [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= 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= 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= [Alias for "environment"]

DESCRIPTION Lists all environment variables for a given environment`

_See code: src/commands/serverless/env/list.js_

twilio serverless:env:set

Sets an environment variable with a given key and value

FLAGS -c, --config= 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= [default: info] Level of logging messages. -o=(columns|json|tsv|none) [default: columns] Format of command output. -p, --profile= Shorthand identifier for your profile. -u, --username= A specific API key or account SID to be used for deployment. Uses fields in .env otherwise --cwd= Sets the directory of your existing Serverless project. Defaults to current directory --env= Path to .env file for environment variables that should be installed --environment= [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= 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= 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= SID of the Twilio Serverless Service to deploy to --silent Suppress output and logs. This is a shorthand for "-l none -o none". --to= [Alias for "environment"] --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_

twilio serverless:env:unset

Removes an environment variable for a given key

FLAGS -c, --config= 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= [default: info] Level of logging messages. -o=(columns|json|tsv|none) [default: columns] Format of command output. -p, --profile= Shorthand identifier for your profile. -u, --username= A specific API key or account SID to be used for deployment. Uses fields in .env otherwise --cwd= Sets the directory of your existing Serverless project. Defaults to current directory --env= Path to .env file for environment variables that should be installed --environment= [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= 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= 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= SID of the Twilio Serverless Service to deploy to --silent Suppress output and logs. This is a shorthand for "-l none -o none". --to= [Alias for "environment"]

DESCRIPTION Removes an environment variable for a given key`

_See code: src/commands/serverless/env/unset.js_

twilio serverless:init NAME

Creates a new Twilio Function project

ARGUMENTS NAME Name of Serverless project and directory that will be created

DESCRIPTION Creates a new Twilio Function project`

_See code: src/commands/serverless/init.js_

twilio serverless:list [TYPES]

List existing services, environments, variables, deployments for your Twilio Serverless Account

ARGUMENTS [TYPES] [default: services] Comma separated list of things to list (services,environments,functions,assets,variables)

DESCRIPTION List existing services, environments, variables, deployments for your Twilio Serverless Account`

_See code: src/commands/serverless/list.js_

twilio serverless:list-templates

Lists the available Twilio Function templates

`USAGE $ twilio serverless:list-templates [-o ]

FLAGS -o, --output-format= Output the results in a different format

DESCRIPTION Lists the available Twilio Function templates`

_See code: src/commands/serverless/list-templates.js_

twilio serverless:logs

Print logs from your Twilio Serverless project

FLAGS -c, --config= 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= [default: info] Level of logging messages. -o=(columns|json|tsv|none) [default: columns] Format of command output. -o, --output-format= Output the results in a different format -p, --profile= Shorthand identifier for your profile. -u, --username= A specific API key or account SID to be used for deployment. Uses fields in .env otherwise --cwd= Sets the directory of your existing Serverless project. Defaults to current directory --env= Path to .env file for environment variables that should be installed --environment= [default: dev] The environment to retrieve the logs for --function-sid= 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= 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= 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= [Alias for "environment"]

DESCRIPTION Print logs from your Twilio Serverless project`

_See code: src/commands/serverless/logs.js_

twilio serverless:new [NAMESPACE]

Creates a new Twilio Function based on an existing template

`USAGE $ twilio serverless:new [NAMESPACE] [-l ] [-c ] [--cwd ] [--env ] [--template ]

ARGUMENTS [NAMESPACE] The namespace your assets/functions should be grouped under

DESCRIPTION Creates a new Twilio Function based on an existing template`

_See code: src/commands/serverless/new.js_

twilio serverless:promote

Promotes an existing deployment to a new environment

DESCRIPTION Promotes an existing deployment to a new environment

ALIASES $ twilio serverless:activate`

_See code: src/commands/serverless/promote.js_

twilio serverless:run [DIR]

Starts local Twilio Functions development server

ARGUMENTS [DIR] Root directory to serve local Functions/Assets from

DESCRIPTION Starts local Twilio Functions development server

ALIASES $ twilio serverless:dev $ twilio serverless:run`

twilio serverless:start [DIR]

Starts local Twilio Functions development server

ARGUMENTS [DIR] Root directory to serve local Functions/Assets from

DESCRIPTION Starts local Twilio Functions development server

ALIASES $ twilio serverless:dev $ twilio serverless:run`

_See code: src/commands/serverless/start.js_

`Contributing`

This project welcomes contributions from the community. Please see the CONTRIBUTING.md` file for more details.

$3

Please be aware that this project has a Code of Conduct. The tldr; is to just be excellent to each other ❤️

$3

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!

License

MIT

@twilio-labs/plugin-serverless

@twilio-labs/plugin-serverless

Requirements

$3

Usage

$3

Commands

twilio serverless:activate

twilio serverless:deploy

twilio serverless:dev [DIR]

twilio serverless:env:get

twilio serverless:env:import

twilio serverless:env:list

twilio serverless:env:set

twilio serverless:env:unset

twilio serverless:init NAME

twilio serverless:list [TYPES]

twilio serverless:list-templates

twilio serverless:logs

twilio serverless:new [NAMESPACE]

twilio serverless:promote

twilio serverless:run [DIR]

twilio serverless:start [DIR]

Contributing

$3

$3

License

@twilio-labs/plugin-serverless

@twilio-labs/plugin-serverless

Requirements

$3

Usage

$3

Commands

twilio serverless:activate

twilio serverless:deploy

twilio serverless:dev [DIR]

twilio serverless:env:get

twilio serverless:env:import

twilio serverless:env:list

twilio serverless:env:set

twilio serverless:env:unset

twilio serverless:init NAME

twilio serverless:list [TYPES]

twilio serverless:list-templates

twilio serverless:logs

twilio serverless:new [NAMESPACE]

twilio serverless:promote

twilio serverless:run [DIR]

twilio serverless:start [DIR]

Contributing

$3

$3

License

Dist Tags

`Usage`

`$3`

`Commands`

`Contributing`

`Usage`

`$3`

`Commands`

`Contributing`