@hooksbase/cli

Official Hooksbase command-line interface. The installed executable name is hooksbase.

Install

npm install --global @hooksbase/cli

Usage

hooksbase skills get hooksbase
hooksbase auth login
hooksbase projects get --json
hooksbase projects update --file ./project.json --json
hooksbase templates list --json
hooksbase http-packs list --json
hooksbase webhooks list --limit 20 --json
hooksbase webhooks routing get wh_123 --json
hooksbase webhooks deliveries wh_123 --limit 20 --json
hooksbase webhooks email-allowlist list wh_123 --json
hooksbase schedules create wh_123 --file ./schedule.json
hooksbase deliveries bulk-replay --idempotency-key replay-1 --file ./bulk-replay.json
hooksbase event-drains list --json
hooksbase automations create --webhook wh_123 --name "Normalize inbound event" --json
hooksbase automations update auto_123 --file ./automation-patch.json --json
hooksbase automations versions list auto_123 --json
hooksbase automations versions create auto_123 --file ./transform.js --activate --json
hooksbase automations versions create auto_123 --file ./transform.js --module helper.js=./helper.js --compatibility-flag nodejs_compat
hooksbase automations bind wh_123 auto_123 --json
hooksbase automations runs list --automation auto_123 --json
hooksbase automations runs get run_123 --json
hooksbase automations runs egress-events run_123 --json
hooksbase automations runs export --format jsonl --automation auto_123 --limit 100
hooksbase automations quotas --json
hooksbase automations usage --month 2026-05 --json
hooksbase automations templates list --json
hooksbase automations egress list --json
hooksbase automations egress get pol_123 --json
hooksbase automations egress update pol_123 --file ./egress-policy-patch.json --json
hooksbase automations egress credentials rotate pol_123 cred_123 --secret-file ./secret.txt --json
hooksbase audit-logs export --format jsonl
hooksbase files download-delivery wh_123 del_123 0 --output ./attachment.bin
hooksbase usage show --from 1740000000000 --to 1740086400000 --json
hooksbase ingest send --ingest-url https://hooks.hooksbase.com/v1/ingest/hook_123 --ingest-secret whsec_... --file ./payload.json
hooksbase ingest send --webhook-name orders --ingest-secret whsec_... --file ./payload.json --json

AI agent start

hooksbase skills list
hooksbase skills get hooksbase
hooksbase skills get webhook-ops
hooksbase skills get automations
hooksbase skills path hooksbase

Bundled skills ship with the CLI and match the installed command version. Agents should load hooksbase skills get hooksbase before operating Hooksbase from a terminal, then use the specialized skills for webhook operations or Automations.

hooksbase auth login opens the Hooksbase dashboard by default and creates a project-scoped admin API key for the selected project. For CI or custom environments, pass --api-key or set HOOKSBASE_API_KEY to validate and store an existing project API key. --base-url is still available for custom API hosts, and --app-url / HOOKSBASE_APP_URL can point browser login at a custom dashboard host.

Use hooksbase auth logout --yes to delete the selected local profile without revoking the remote key. Use hooksbase auth profiles delete <name> --yes to delete another local profile.

The CLI supports:

• profile-based auth with admin and write project API keys
• current-project inspection/update, project API key management, audit log reads, and webhook template reads
• HTTP pack reads, webhook destination, routing, classic transform, Starter+ Automations, Code Mode versions, Enterprise egress, automation templates, test-delivery, metrics, backlog, email allowlist, schedule, delivery, replay, DLQ, event-drain, file download, and bulk-operation commands
• operator notification, alert channel, alert rule, and operator incident commands
• stable --json output for automation
• bundled, version-matched agent skills through hooksbase skills
• cursor-based pagination flags on remote list commands
• JSON file-driven create flows for webhooks and schedules
• public ingest sends without requiring a project API key
• form ingest remains browser/raw HTTP only

Supported environment variables:

• HOOKSBASE_PROFILE
• HOOKSBASE_BASE_URL
• HOOKSBASE_API_KEY
• HOOKSBASE_APP_URL