Skip to contentSkip to navigationSkip to topbar
Rate this Page:

Getting Started


(information)

Info

This is a Twilio Labs project

This means this project is 100% open-source. You can find its source code in the Twilio Labs GitHub organization(link takes you to an external page).

We currently don't support the projects through our official support channels. But you are welcome to reach out to us on GitHub for any questions, issues or suggestions or to contribute to this project.

Learn more about Twilio Labs.


Install the Twilio Serverless Toolkit

install-the-twilio-serverless-toolkit page anchor

Before we can get started using the Twilio Serverless Toolkit, we need to install it.

There are two ways you can use the toolkit. If you are already using the Twilio CLI, you can install it via a plugin. Alternatively, you can use the toolkit as a standalone using twilio-run(link takes you to an external page) via npm or another Node.js package manager.

Throughout the docs, you'll find all instructions using the Twilio CLI.

When would I use which version?

when-would-i-use-which-version page anchor

If you and the people who work with you on the project have the Twilio CLI installed, your best bet will be to use the plugin(link takes you to an external page). If you intend to install the toolkit as a dependency directly to your project, you can alternatively install twilio-run(link takes you to an external page) as a devDependency in your Node.js project.

Install Twilio Serverless Toolkit

install-twilio-serverless-toolkit page anchor

To get started, you'll have to install the Twilio Serverless Toolkit using the Twilio CLI


_10
# Install the Serverless plugin
_10
twilio plugins:install @twilio-labs/plugin-serverless
_10
_10
# See a list of available commands:
_10
twilio serverless --help


Update the Serverless Toolkit

update-the-serverless-toolkit page anchor

You can update Twilio CLI plugins by running twilio plugins:update, but this might not pull the very latest version. Instead, uninstall and re-install the plugin.

Update the Serverless Toolkit

update-the-serverless-toolkit-1 page anchor

_10
# Uninstall the existing Serverless Toolkit
_10
twilio plugins:remove @twilio-labs/plugin-serverless
_10
_10
# Install the latest version of the Serverless Toolkit
_10
twilio plugins:install @twilio-labs/plugin-serverless@latest


Explore the commands and options

explore-the-commands-and-options page anchor

You can find all available commands using the --help flag on the toolkit or a specific command.

Get help in Twilio Serverless Toolkit

get-help-in-twilio-serverless-toolkit page anchor

_10
# List all available commands
_10
twilio serverless --help
_10
_10
# Get available flags and description for a specifically
_10
# for a command like deploy
_10
twilio serverless:deploy --help


Now that we have the toolkit installed let's see what we can do with it.


Rate this Page: