CLI - Postboi

The postboi package carries a CLI: bunx postboi <command> (or npx). Setup and the dev tools work with any provider; the account commands need the Postboi provider’s POSTBOI_TOKEN, which init writes. Every account command takes --json for the API’s response as one document, and a failure carries the API’s code — what a script or an agent should branch on.

Setup and tools

Command	What it does
`bunx postboi init`	Set up the Postboi provider or a provider of your own — `--agent: zero prompts, zero sign-in — provisions a claimable sandbox account (made for AI coding agents and CI)` · `--sms · --whatsapp · --push · --chat: set up that channel instead`
`bunx postboi sync`	Pull synced team credentials and refresh the generated from/template types
`bunx postboi env`	The synced credentials — `push · pull [--force] · remove <KEY>`
`bunx postboi vapid`	Mint a VAPID key pair for Web Push, printed to stdout
`bunx postboi doctor`	Is this project wired? Token, provider, from address, webhooks, skill — `--json · exit 1 on a failure`
`bunx postboi skill`	Install the agent skill, so AI coding agents know the library
`bunx postboi dev`	Local inbox for mail sent in development — `--port <n> --demo --no-sound --no-intro` · `(Vite projects already serve it at /__postboi)`
`bunx postboi inspect`	Lint an email’s HTML — client compatibility, clipping, dead links — `<file.html> · --links --subject <s> --json (exit 1 on warnings)`

The account

Postboi provider — full reference: https://api.postboi.app

Command	What it does
`bunx postboi whoami`	The account behind your token
`bunx postboi send`	One email, now — `--to <emails> --subject <s> --text <t>, --html <h> or --file <body> [--at <ISO>]`
`bunx postboi send-address`	Default sending address — `[name@yourdomain.com]`
`bunx postboi lists`	Lists — `add <name> · send <list> --subject <s> --text, --html or --file <body> · delete <ref>`
`bunx postboi recipients`	A list’s recipients — `<list> add <email>… · <list> remove <email>`
`bunx postboi contacts`	The audience — `add <email> [--name --phone --data] · <email> · remove <email>`
`bunx postboi domains`	Sending domains — `add <domain> · check <ref> · inbound <domain> [--off] · delete <ref>`
`bunx postboi webhooks`	Webhooks — `add <url> · rotate <id> · deliveries <id> · delete <id>`
`bunx postboi members`	Members — `invite <email> · remove <ref> · revoke <ref>`
`bunx postboi messages`	Recent messages — `[status] · <id> (status, opens, fields) · cancel <id>`
`bunx postboi exports`	Exports — `download [--form <form>] [--xlsx] [--out <file>]` · `add <name> --to <emails> --weekly · run · pause · resume · delete <id>`
`bunx postboi suppressions`	Suppressed addresses — `add <email or +phone> · remove <email or +phone>`
`bunx postboi forms`	The forms submissions are filed under — `(named in your code)`
`bunx postboi notifications`	A list’s digests — `<list> · <list> add --to <emails> --weekly or --on-signup · <list> delete <id>`
`bunx postboi testing`	Email tests — `add [--label] [--clients] · <id> (the report) · clients · delete <id>`

A bare noun lists; list says the same. Add —json to any of them for the API’s response as JSON (errors carry the API’s code).

For agents

bunx postboi init --agent provisions a claimable sandbox account with no prompts and no sign-in, bunx postboi skill installs the agent skill that teaches the library, and bunx postboi doctor says whether a project is wired. This page is also plain Markdown at /raw/cli.