@twilio-labs/plugin-flex

@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:create-configuration
• twilio flex:plugins:deploy
• twilio flex:plugins:describe:configuration
• twilio flex:plugins:describe:plugin
• twilio flex:plugins:describe:plugin-version
• twilio flex:plugins:describe:release
• twilio flex:plugins:diff ID1 [ID2]
• twilio flex:plugins:list:configurations
• twilio flex:plugins:list:plugin-versions
• twilio flex:plugins:list:plugins
• twilio flex:plugins:list:releases
• twilio flex:plugins:release
• twilio flex:plugins:start
• twilio flex:plugins:upgrade-plugin

twilio flex:plugins:build

Builds 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
  --json  Outputs the result of the command as json string

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

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
  -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-. This command needs to be invoked inside a plugin directory.

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

twilio flex:plugins:create-configuration

Creates a Flex Plugin Configuration. This command needs to be invoked inside a plugin directory.

USAGE
  $ twilio flex:plugins:create-configuration

OPTIONS
  --description=description  The description of this Flex Plugin Configuration
  --json                     Outputs the result of the command as json string
  --name=name                [default: Sep 9, 2020] The friendly name of the Flex Plugin Configuration
  --new                      The friendly name of the Flex Plugin Configuration

  --plugin=plugin            (required) The plugin to install, formatted as pluginName@version. Use additional --plugin
                             to provide other plugins to install

See code: src/commands/flex/plugins/create-configuration.ts

twilio flex:plugins:deploy

Builds and deploys a new version of Flex plugin to your Flex application. This command needs to be invoked inside a plugin directory.

USAGE
  $ twilio flex:plugins:deploy

OPTIONS
  --changelog=changelog      The changes (added/removed) made in this plugin version
  --description=description  The description of this Flex plugin
  --json                     Outputs the result of the command as json string
  --major                    Publishes the version as a major (semver)
  --minor                    Publishes the version as a minor (semver)
  --patch                    Publishes the version as a patch (semver); this is the default
  --public                   Publishes the plugin as a public Twilio Asset; default is private
  --version=version          The custom version to publish

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

twilio flex:plugins:describe:configuration

Describes a Flex Plugin Configuration and its associated Plugins.

USAGE
  $ twilio flex:plugins:describe:configuration

OPTIONS
  --json     Outputs the result of the command as json string
  --sid=sid  (required) The Flex Plugin Configuration SID

See code: src/commands/flex/plugins/describe/configuration.ts

twilio flex:plugins:describe:plugin

Describes a Flex Plugin and its Flex Plugin Versions.

USAGE
  $ twilio flex:plugins:describe:plugin

OPTIONS
  --json       Outputs the result of the command as json string
  --name=name  (required) The Flex Plugin name to describe

See code: src/commands/flex/plugins/describe/plugin.ts

twilio flex:plugins:describe:plugin-version

Describes a Flex Plugin Version.

USAGE
  $ twilio flex:plugins:describe:plugin-version

OPTIONS
  --json             Outputs the result of the command as json string
  --name=name        (required) The Flex Plugin name of the Plugin Version to describe
  --version=version  (required) The Flex Plugin Version to describe

See code: src/commands/flex/plugins/describe/plugin-version.ts

twilio flex:plugins:describe:release

Describes a Flex Plugin Release and its Plugin Configuration.

USAGE
  $ twilio flex:plugins:describe:release

OPTIONS
  --active
  --json     Outputs the result of the command as json string
  --sid=sid  The Flex Plugin Release SID to describe

See code: src/commands/flex/plugins/describe/release.ts

twilio flex:plugins:diff ID1 [ID2]

Finds the diff between two configurations.

USAGE
  $ twilio flex:plugins:diff ID1 [ID2]

ARGUMENTS
  ID1  The first Flex Plugin Configuration SID
  ID2  The second Flex Plugin Configuration SID

OPTIONS
  --json  Outputs the result of the command as json string

See code: src/commands/flex/plugins/diff.ts

twilio flex:plugins:list:configurations

Lists the Flex Plugin Configuration on the account.

USAGE
  $ twilio flex:plugins:list:configurations

OPTIONS
  --json  Outputs the result of the command as json string

See code: src/commands/flex/plugins/list/configurations.ts

twilio flex:plugins:list:plugin-versions

Lists the Flex Plugin Versions on the account.

USAGE
  $ twilio flex:plugins:list:plugin-versions

OPTIONS
  --json       Outputs the result of the command as json string
  --name=name  (required) The plugin name to list its versions

See code: src/commands/flex/plugins/list/plugin-versions.ts

twilio flex:plugins:list:plugins

Lists the Flex Plugins on the account.

USAGE
  $ twilio flex:plugins:list:plugins

OPTIONS
  --json  Outputs the result of the command as json string

See code: src/commands/flex/plugins/list/plugins.ts

twilio flex:plugins:list:releases

Lists the Flex Releases on the account.

USAGE
  $ twilio flex:plugins:list:releases

OPTIONS
  --json  Outputs the result of the command as json string

See code: src/commands/flex/plugins/list/releases.ts

twilio flex:plugins:release

Creates a Flex Plugin Release. This command needs to be invoked inside a plugin directory.

USAGE
  $ twilio flex:plugins:release

OPTIONS
  --configuration-sid=configuration-sid  The Flex Plugin Configuration SID to release; other options are not required
                                         when using this option

  --description=description              The description of this Flex Plugin Configuration

  --json                                 Outputs the result of the command as json string

  --name=name                            [default: Sep 9, 2020] The friendly name of the Flex Plugin Configuration

  --new                                  The friendly name of the Flex Plugin Configuration

  --plugin=plugin                        The plugin to install, formatted as pluginName@version. Use additional --plugin
                                         to provide other plugins to install

See code: src/commands/flex/plugins/release.ts

twilio flex:plugins:start

Starts a dev-server to build the Flex plugin locally. If the --name flag is used at least once, the command does not need to be invoked in a plugin directory. Else, it does.

USAGE
  $ twilio flex:plugins:start

OPTIONS
  --include-remote  Use this flag to include all remote plugins in your build
  --json            Outputs the result of the command as json string

  --name=name       The name of the plugin(s) you would like to run, formatted as pluginName to run locally, or
                    pluginName@remote to run remotely

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

twilio flex:plugins:upgrade-plugin

Upgrades the scaffolding of the plugin to the latest version.

USAGE
  $ twilio flex:plugins:upgrade-plugin

OPTIONS
  --beta     If set, will upgrade to the latest beta version
  --install  If set, will run npm install as well
  --json     Outputs the result of the command as json string

See code: src/commands/flex/plugins/upgrade-plugin.ts