Back to Activepieces

@activepieces/cli

packages/cli/README.md

0.86.31.6 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 an API key/token or email + password (no sign-up):

bash
# API key or user token (Bearer) — project must be given explicitly
AP_API_KEY=<key> npx @activepieces/cli benchmark --project-id <id> --requests 500 --concurrency 10

# or email/password login — project is resolved automatically
npx @activepieces/cli benchmark --email [email protected] --password '…' --requests 500 --concurrency 10
OptionDefaultDescription
--urlhttp://localhost:3000Activepieces base URL (dev env API port)
--requests500Total requests to fire
--concurrency10Concurrent connections
--api-keyAP_API_KEY envPlatform API key or user token (Bearer); requires --project-id
--project-idProject to create the flow in (required with --api-key)
--email / --passwordLogin instead of an API key; resolves the project automatically
--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.