Deprecated

This repo is deprecated and has moved into flex-plugin-builder monorepo.

@twilio-labs/plugin-flex

Twilio CLI plugin to interact with the Flex Plugin Builder

This plugin adds functionality to the Twilio CLI to locally develop, build and deploy Twilio Flex plugins; it uses the Flex Plugin Builder.

• Requirements
• Usage
• Commands

Requirements

Install the Twilio CLI

Via npm or yarn:

$ npm install -g twilio-cli
$ yarn global add twilio-cli

Via homebrew:

$ brew tap twilio/brew && brew install twilio

Usage

$ twilio plugins:install @twilio-labs/plugin-flex
$ twilio --help flex
USAGE
  $ twilio flex
...

Commands

• twilio flex:plugins:build
• twilio flex:plugins:create NAME
• twilio flex:plugins:deploy
• twilio flex:plugins:remove
• twilio flex:plugins:start

twilio flex:plugins:build

Builds your Flex plugin and creates a JavaScript and sourcemap bundle. This command needs to be invoked inside a plugin directory.

USAGE
  $ twilio flex:plugins:build

OPTIONS
  -l=(debug|info|warn|error|none)  [default: info] Level of logging messages.
  -o=(columns|json|tsv)            [default: columns] Format of command output.
  -p, --profile=profile            Shorthand identifier for your profile.

See code: src/commands/flex/plugins/build.js

twilio flex:plugins:create NAME

Creates a new Twilio Flex Plugin project

USAGE
  $ twilio flex:plugins:create NAME

ARGUMENTS
  NAME  Creates a new Twilio Flex Plugin project

        Arguments:
        name	Name of your plugin. Needs to start with plugin-

OPTIONS
  -a, --accountSid=accountSid      The Account SID for your Flex Project
  -h, --help=help
  -i, --install                    Auto-install dependencies
  -l=(debug|info|warn|error|none)  [default: info] Level of logging messages.
  -o=(columns|json|tsv)            [default: columns] Format of command output.
  -p, --profile=profile            Shorthand identifier for your profile.
  -r, --runtimeUrl                 Auto-install dependencies
  -s, --typescript                 Create a TypeScript project
  -t, --template=template          A URL to a template directory
  -v, --version=version
  -y, --yarn                       Use yarn as your dependency manager

DESCRIPTION
  Arguments:
  name	Name of your plugin. Needs to start with plugin-.

See code: src/commands/flex/plugins/create.js

twilio flex:plugins:deploy

Builds and deploys your Flex plugin to Twilio Assets. This command needs to be invoked inside a plugin directory.

USAGE
  $ twilio flex:plugins:deploy

OPTIONS
  -l=(debug|info|warn|error|none)  [default: info] Level of logging messages.
  -o=(columns|json|tsv)            [default: columns] Format of command output.
  -p, --profile=profile            Shorthand identifier for your profile.

See code: src/commands/flex/plugins/deploy.js

twilio flex:plugins:remove

Removes your Flex plugin. This command needs to be invoked inside a plugin directory.

USAGE
  $ twilio flex:plugins:remove

OPTIONS
  -l=(debug|info|warn|error|none)  [default: info] Level of logging messages.
  -o=(columns|json|tsv)            [default: columns] Format of command output.
  -p, --profile=profile            Shorthand identifier for your profile.

See code: src/commands/flex/plugins/remove.js

twilio flex:plugins:start

Starts a dev-server to build your Flex plugin locally. This command needs to be invoked inside a plugin directory.

USAGE
  $ twilio flex:plugins:start

OPTIONS
  -l=(debug|info|warn|error|none)  [default: info] Level of logging messages.
  -o=(columns|json|tsv)            [default: columns] Format of command output.
  -p, --profile=profile            Shorthand identifier for your profile.

See code: src/commands/flex/plugins/start.js