Skip to main content

Installation

No global installation required. Run the CLI on-demand with npx.
npx posthook <command>

Commands

CommandDescription
loginStore your Posthook API key
logoutClear stored API keys
listenReceive webhooks on localhost via WebSocket
initPull remote config into a local posthook.toml
pullDownload remote config, overwriting the local file
applyPush local config to the remote project
diffShow pending changes between local and remote
statusDisplay project info, signing key, and masked API key
validateCheck TOML syntax locally without an API call

Common flags

FlagApplies toDescription
-k, --api-key <key>listen, init, pull, apply, diffOverride the stored API key
-c, --config <name>init, pull, apply, diff, status, validateUse a named config file (posthook.<name>.toml)
You can also set the POSTHOOK_API_KEY environment variable instead of using --api-key.