Skip to main content

Build Custom Integrations

You can use the CLI to build custom integrations for the platform. This process compiles the integrations and exports them as a .tgz packed archive.

How It Works​

The CLI scans the packages/integrations/ directory for the specified integration. It checks the name in the package.json file. If the integration is found, it builds and packages it into a .tgz archive.

Usage​

To build a integration, follow these steps:

  1. Ensure you have the CLI installed by cloning the repository.
  2. Run the following command:
npm run build-integration

You will be prompted to enter the name of the integration you want to build. For example:

? Enter the integration folder name : google-drive

The CLI will build the integration and you will be given the path to the archive. For example:

Integration 'google-drive' built and packed successfully at dist/packages/integrations/community/google-drive

You may also build the integration non-interactively by passing the integration name as an argument. For example:

npm run build-integration google-drive