Skip to main content
The Puffle CLI is not currently published as a supported npm package or downloadable customer binary. The commands on this page require access to Puffle’s private repository and are for maintainers or explicitly authorized source checkouts. Customer integrations should call the documented HTTPS API directly.

​
Availability

There is no public installation command. In an authorized private source checkout, maintainers regenerate the local command manifest whenever a public API reference route changes:
Maintainers can run the generated entrypoint directly during local development:
The private repository can build a local puffle executable into dist/cli/puffle.js for development and validation. This build step does not publish or install a customer package:

​
Authenticate

If you are using an authorized local build, set your API key in PUFFLE_API_KEY.
The CLI sends the key as a Bearer token to the same API routes shown in the API reference.

​
Usage

Commands are derived from public API routes. Public docs call the product surface Outbound, but generated command names may preserve implementation nouns such as campaign where the underlying API path is /api/campaigns. Path parameters, query parameters, and request body fields become flags unless a route explicitly opts into positional arguments. Use --help on any generated command to see the route summary, required flags, optional flags, and examples from the manifest. Example shapes:

​
Global Flags

Set PUFFLE_API_BASE_URL to point the CLI at a preview or local server.

​
Flag Values

String and number flags are passed as shell values. Boolean flags are presence-only, so --include-stats sends true. Array and object request fields are JSON flags. Quote JSON values so the shell passes them as one argument. If JSON parsing fails, the CLI exits before making a request.

​
API Reference

CLI commands are generated from route metadata and emitted into OpenAPI as CLI metadata when a route opts into CLI generation. Session-only, admin-only, UI-only, and private routes do not get public CLI commands. If a route is not in the API Reference, treat it as outside the public CLI/API contract.

​
For AI Agents

The CLI is a private development client for the API contract, not a generally available agent prerequisite. Agents without an explicitly provided authorized build must use the HTTPS API. Even with a local build, prefer the API reference for request and response schemas. If an endpoint is removed from the API reference, its generated CLI command should disappear with it. For machine-readable workflows, keep the default --format json output and parse stdout. Request failures are written to stderr and return a non-zero exit code.