Quick Start
Install the CLI, sign in, pick an environment, run your first reads, and rehearse before you spend money.
Postsale CLI is the terminal and agent interface for post-purchase shipping on your Postsale account: orders, rates, labels, structured output, and safety gates.
This page gets you to a trustworthy read-only session in a few minutes. For the full onboarding checklist, continue with Your First Hour with the CLI.
Choose your path
| You are... | Start here |
|---|---|
| Shipping with the CLI (operator) | Steps below, then Ship One Order |
| Running unattended | Batches and Unattended Runs |
| Hosting an agent | Agent Quick Reference and AGENTS.md |
Before We Begin
To get started, you will need:
- A Postsale account
- (Optional) An LLM API key for
postsale run
Install today: the CLI is a single signed, self-contained program: nothing else to install and no runtime required. A public one-line installer is still rolling out; until then you install the program directly (see below). The CLI reports its own version from postsale --version.
1. Install
Install the signed program from your invitation: put it on your PATH and verify. Nothing else to install, no runtime needed.
postsale --version # prints the CLI's own semver2. Sign in
postsale auth login # or: --no-browser
postsale auth statusDetails: Sign In and Credentials.
3. Preflight and first reads
postsale doctor --human
postsale account whoami
postsale orders search --query "orders from last 7 days" --page-size 5 --human4. Ask the agent a question
Set ANTHROPIC_API_KEY (or ANTHROPIC_AUTH_TOKEN) or OPENAI_API_KEY, then:
postsale run "how many carriers and origin addresses do I have?"Stdout is one JSON envelope. Progress was on stderr. See Output and Exit Codes.
5. Product check: what should I ship?
postsale orders work-queue --humanNo LLM key needed for this one. The same answer via the agent, if you set a key in step 4:
postsale run "what should I ship? explain the applied filters and exclusions"Prefer the work queue over inventing status names: they are defined by your account, and guessing wrong fails quietly. Read the excluded counts in the response: a small queue next to a large outside_resolved_statuses means real work is sitting in statuses the queue did not match. Details: Search for Orders and Use the Work Queue.
6. Before any money
Read Safety Model, then rehearse:
postsale run --dry-run "Ship order <order_id> with the cheapest carrier"Additional Reading
Still have a question? Ask a person.
Write to support@postsale.com or send us a message. We reply the same business day, Monday to Friday, 8 AM to 5 PM Central.