Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

Flex Plugins CLI



Check out the Flex Plugin Library. It requires Flex UI 2.x.x and gives you access to ready-to-install plugins without using the CLI.

The Flex Plugins CLI (command line interface) is the interface for developing, testing, and releasing plugins. It accelerates your plugin development by automating the key workflows you'll use while customizing Flex for your users. All plugins developed using the Plugins CLI can be managed on the Plugins Dashboard.

CLI Features

cli-features page anchor

Build new plugins

build-new-plugins page anchor

The Flex Plugins CLI enables you to create new plugins in JavaScript or TypeScript. You can start with a blank slate, or create a plugin from a pre-existing template with the --template parameter. You can manage packages either via NPM(link takes you to an external page) or Yarn(link takes you to an external page) (Supported in Flex UI versions 1.19 and up).

Deploy and release plugin versions

deploy-and-release-plugin-versions page anchor

The Flex Plugins CLI is built on the Plugins API. You can define plugin versions to track incremental updates to your customer experience. Deploy updates for each of your plugins individually, or bundle all of your updates together in a single release.

Manage your version and release history

manage-your-version-and-release-history page anchor

All of the updates to your plugin versions are tracked as a history of releases. Use this history to quickly identify and track changes in your application, and select a prior configuration to re-release in the event of an issue with your users.

Validate your plugin code

validate-your-plugin-code page anchor

Get code recommendations from the Flex Plugins CLI to help you follow best practices for maintaining the compatibility of your plugins as Flex UI evolves. Plugin code validation runs implicitly when you use the plugin Deploy command. You can also use the Validate command to run it explicitly.

  • Install the Plugins CLI
  • Migrate your legacy plugins to use the new CLI
  • Check out the Reference Guide to see everything the Plugins CLI can do

Rate this page: