Skip to content

Caraer CLI

The Caraer CLI (caraer-cli) is the downloadable developer tool for managing Caraer apps, webhooks, serverless functions, schedules, inbound routes, and local developer projects.

Terminal window
pipx install caraer-cli
# or from a local checkout:
pip install -e ".[dev]"
Terminal window
caraer auth login --email you@example.com
caraer company select <company-uuid>
caraer apps init --label "My Sync App"
cd my_sync_app
caraer apps add function sync-handler
caraer apps add schedule renew-watch --function sync-handler
caraer apps add inbound provider-push --function sync-handler
caraer apps push
caraer apps local logs
caraer apps local dev
caraer sandbox create --name my-sandbox

Developer project mutations require the app creator company (or super-admin). Knowing an app UUID alone is not authorization.

Typed serverless payloads live in the Caraer clients (@caraer/client / caraer-client).

CLI 0.1.12+ exposes automatic deactivation for the selected company’s webhooks:

Terminal window
caraer company select <company-uuid>
caraer webhooks list --app <app-uuid>
caraer webhooks show <webhook-uuid> --app <app-uuid>

After fixing and testing the destination, explicitly resume future deliveries with the same app-resource edit permissions used to edit the webhook:

Terminal window
caraer webhooks reactivate <webhook-uuid> --app <app-uuid>
caraer webhooks show <webhook-uuid> --app <app-uuid>

Expect deactivated: false and failureCount: 0. Only the selected company’s subscription resumes; old queued events are not replayed. Tests and project pushes preserve automatic deactivation. See webhook recovery for failure thresholds, status fields, and verification with a new sandbox event.