Community

Learn how to publish your piece to the community.

You can publish your pieces to npm registry and share them with the community, users can install your piece from Settings -> My Pieces -> Install Piece -> type in the name of your piece package.

1. Login to npm

   Make sure you are logged in to npm. If not, please run:

   npm login
   

2. Rename Piece

   Rename the piece name in package.json to something unique or related to your organization’s scope (Ex: @my-org/piece-PIECE_NAME). You can find it at packages/pieces/PIECE_NAME/package.json.

   Don’t forget to increase the version number in package.json for each new release.

3. Publish

   Replace PIECE_NAME with the actual name of your piece.

   Run the following command:

   npm run publish-piece PIECE_NAME
   

Congratulations! You can now import the piece from the settings page.