Twilio Flex Plugin Builder

Monorepo for all the tooling needed to create a custom Twilio Flex Plugins

Getting Started

Flex Plugin Builder requires Node.js. We support and recommend the LTS versions of Node. This is a monorepo project managed by lerna for creating Twilio Flex plugins.

• @twilio-labs/plugin-flex: The CLI tool for creating, building, testing, deploying, and managing your plugins

Local Development Setup

For local development of the Flex Plugin Builder itself, follow these steps:

Initial Setup

1. Clone the repository and install dependencies:

   npm install

2. Link all packages for local development:

   npm run link-packages

   This command will:

   • Create global npm links for all packages in the /packages folder
   • Link internal dependencies between packages
   • Run npm run link in the plugin-flex package to register the CLI tool

Development Workflow

After making any changes to the source code, rebuild the packages:

npm run build

This ensures that all TypeScript files are compiled and changes are reflected across linked packages.

Development Tips

• The link-packages script only needs to be run once during initial setup
• Run npm run build after every code change to see your changes take effect
• Use npm run test to run all tests across packages
• Individual packages can be built using lerna run build --scope=@twilio/<package-name>

User Guide

Please visit Twilio Docs for the latest docs on Plugins CLI and API.

• Plugins CLI
• Plugins API
• Troubleshooting and FAQ

Changelog

Major changelogs can be found in the changelog directory.

Contributing

Check out CONTRIBUTING for more information on how to contribute to this project.

License

Flex Plugin Builder is licensed under MIT.

Contributors

Thanks to the wonderful people listed in CONTRIBUTORS.md.

This project follows the all-contributors specification. Contributions of any kind welcome!