This page describes the available commands in the Flex Plugins CLI and their associated parameters.
For general Flex Plugins CLI usage help, you can run twilio flex:plugins --help
from your command line. To review the command usage details as well as required and optional flags, run twilio flex:plugins:COMMAND --help
.
_10twilio flex:plugins:archive
Archives a plugin, a plugin version, or a configuration.
Options | Description |
---|---|
--json | Outputs the result of the command as a JSON string |
--name=plugin_name | The name of the plugin to archive |
--version=version_number | The version of a plugin to archive |
--sid=configuration_sid | The SID of a configuration to archive |
_10twilio flex:plugins:build
Builds Flex plugin and creates a JavaScript and sourcemap bundle. This command needs to be invoked inside a plugin directory.
_10twilio flex:plugins:create NAME
Creates a new Twilio Flex Plugin project.
Arguments | Description |
---|---|
Name | The name of your plugin. |
Options | Description |
---|---|
-a, --accountSid=accountSid | The Account SID for your Flex Project |
--flexui1 | Creates a plugin compatible with Flex UI 1.0 |
--flexui2 | Creates a plugin compatible with Flex UI 2.0 |
-i, --install | Auto-install dependencies |
-r, --runtimeUrl | The Runtime URL for your Flex Project |
-s, --typescript | Create a TypeScript project |
-t, --template=template | A URL to a template direction |
-v, --version=version | Start your plugin at a particular version |
-y, --yarn | Use yarn as your dependency manager |
_10twilio flex:plugins:create-configuration
Creates a Flex Plugin Configuration. This command is not required to be run in a plugin directory
Options | Description |
---|---|
--plugin=plugin | Required. The plugin to install, formatted as pluginName@version. Use additional --plugin to provide other plugins to install |
--description=description | The description of this Flex Plugin Configuration |
--enable-plugin=plugin_name | The plugin to enable, formatted as pluginName@version. Use additional -- enable-plugin arguments to provide other plugins to install |
--disable-plugin=plugin_name | The plugin to disable, formatted as pluginName. Use additional --disable-plugin arguments to provide other plugins to disable |
--json | Outputs the result of the command as a JSON string |
--name=name | The friendly name of the Flex Plugin Configuration |
--new | Creates a new Flex Plugin Configuration, otherwise will append to existing active Configuration |
_10twilio flex:plugins:deploy
Deploys a new plugin version. This command needs to be invoked inside a plugin directory.
Options | Description |
---|---|
--version=version | The custom version to publish |
--changelog=changelog | The changes (added/removed) made in this plugin version |
--description=description | The description of the plugin being deployed |
--json | Outputs the result of the command as a JSON string |
--major | Publishes the version as a major version in semantic versioning |
--minor | Publishes the version as a minor version in semantic versioning |
--patch | Publishes the version as a patch in semantic versioning |
--public | Publishes the Plugin as a public Twilio Asset; the default is private |
_10twilio flex:plugins:describe:{release/plugin/configuration}
Can accept Plugin, Plugin-Version, Configuration, or Release as a resource to describe. Provides details like status, description, and associated plugins.
Option | Description |
---|---|
--active | Indicates that you want to describe the most recent release. |
--json | Outputs the result of the command as a JSON string |
--sid=sid | The SID of the resource you want to describe |
_10twilio flex:plugins:diff <ID1> [<ID2>]
Finds the diff between two Flex Plugin Configurations.
Arguments | Description |
---|---|
ID1 | Required. The SID of the Configuration resource to compare to the active Release or to ID2 |
ID2 | Optional. The SID of the Configuration resource to compare to ID1 |
Options | Description |
---|---|
--json | Outputs the result of the command as a JSON string |
_10twilio flex:plugins:list
Can accept Plugin, Plugin-Version, Configuration, or Release as a resource to describe. Lists the resources on the account.
Options | Description |
---|---|
--json | Outputs the result of the command as a JSON string |
_10twilio flex:plugins:release
Creates a Flex Plugin Release. This command is not required to be run in a plugin directory
Options | Description |
---|---|
--new | Creates a new Flex Plugin Configuration, otherwise will append to existing active Configuration |
--enable-plugin=plugin_name | The plugin to enable, formatted as pluginName@version. Use additional -- enable-plugin arguments to provide other plugins to install |
--disable-plugin=plugin_name | The plugin to disable, formatted as pluginName. Use additional --disable-plugin arguments to provide other plugins to disable |
--plugin=plugin_name | Alias for --enable-plugin |
--configuration-sid=your_configuration_sid | The Flex Plugin Configuration SID to release; other options are not required when using this option |
--description=description | The description of this Release |
--json | Outputs the result of the command as a JSON string |
--name=name | The friendly name of the Release |
_10twilio flex:plugins:start
Starts a dev-server to build the Flex plugin locally. This command needs to be invoked inside a plugin directory.
Parameter | Description |
---|---|
--include-remote | Includes all remote plugins in your build |
--json | Outputs the result of the command as a JSON string |
--name=name | The name of the plugin(s) you would like to run |
--port | The port to start the development server |