Back to Activepieces

@activepieces/cli

packages/cli/README.md

0.87.01.3 KB
Original Source

@activepieces/cli

Usage

bash
npx @activepieces/cli <command>

benchmark

Creates a flow (webhook trigger → data mapper → return response), publishes it, then load-tests its synchronous webhook endpoint with autocannon. Defaults target a local dev environment.

Authenticate with a platform-admin API key. The CLI provisions a throwaway project for the run (with a high concurrency cap so a project rate limiter can't skew the numbers) and deletes it after:

bash
AP_API_KEY=<key> npx @activepieces/cli benchmark --url https://your-instance.example.com
OptionDefaultDescription
--urlhttp://localhost:3000Activepieces base URL (dev env API port)
--requests40 × concurrencyTotal requests to fire
--concurrencyauto = execution slotsConcurrent connections
--api-keyAP_API_KEY envPlatform-admin API key (Bearer)
--body{"test":true}JSON body sent to the webhook
--jsonMachine-readable output

Building

Run turbo run build --filter=@activepieces/cli to build the library.

The publishable, self-contained bundle is produced by npm run build-publish (bundles workspace deps with esbuild into dist/) and published via the Release CLI GitHub workflow.