Skip to main content

Documentation Index

Fetch the complete documentation index at: https://www.activepieces.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

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

​
How It Works

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

​
Usage

To build a piece, follow these steps:
  1. Ensure you have the CLI installed by cloning the repository.
  2. Run the following command:
npm run build-piece
You will be prompted to enter the name of the piece you want to build. For example: 
? Enter the piece folder name : google-drive
The CLI will build the piece and you will be given the path to the archive. For example: 
Piece 'google-drive' built and packed successfully at packages/pieces/community/google-drive/dist
You may also build the piece non-interactively by passing the piece name as an argument. For example: 
npm run build-piece google-drive