Postsale CLI
Ship from the command line, in plain English or on a schedule, with nothing spent until you say so.
Getting Started (Invite Only)
Quick Start
Install the CLI, sign in, pick an environment, run your first reads, and rehearse before you spend money.
Your First Hour with the CLI
A guided first hour: install and verify, sign in, run doctor, find shippable work, ask a question in plain language, and dry-run a money path.
Test Without Spending
Rehearse every money path for free: dry-run for previews, test-label mode for real labels that are never billed, and how to see a refusal on purpose.
How the Postsale CLI Works
What the CLI is for, how direct commands and natural language relate, and how a safe first session unfolds.
Sign In and Credentials
Browser sign-in, device sign-in, unattended runs tokens, and API keys, plus how the CLI picks between them and how to check which environment you are on.
Output and Exit Codes
The JSON envelope, what goes to stdout versus stderr, and the exit codes scripts and agents branch on.
Safety Model
The gates between an intent and a charge: confirmations, dry-run, parallel batch authorization, owner actions, and test-label mode.
Orders & Shipping
Orders, Shipments, and Labels
How orders, shipments, rates, and labels relate, and which commands move each one along.
Search for Orders and Use the Work Queue
Find orders with structured or natural-language search, and let the work queue tell you what is ready to ship.
Ship One Order with the CLI
Take a single order from lookup to a purchased label, with the agent or with direct commands, and confirm the result.
Rates, Shipments, and Labels
Compare rates, create a shipment, buy, reprint, and void labels, and handle first-purchase owner actions and test labels.
Void Labels and Correct Shipments
Void a label, fix a shipment, and recover from a wrong purchase without paying twice.
Intent-Shaped Create and Rate Tools
How the agent fills in order and shipment bodies for you, which defaults it applies, and the two rules it will not override.
Ship Many Orders (Interactive Batch)
Ship a batch from the work queue as a human operator, with the checks that keep a batch honest.
Natural Language
Use Natural Language with postsale run
Say what you want in plain language: how the agent loop works, how to authorize money-moving work, and how to read what it did.
Preview Work with Dry-Run
Preview what the agent would do without charging anything, and read which writes were simulated and which still ran.
Batch Work in Parallel (parallelmap)
Fan work out across subagents in parallel, and understand the batch gate that guards money-shaped batches.
Conversations, Traces, and Saved Queries
Continue a conversation, inspect a trace of exactly what ran, and save intents you use often.
Setup & Unattended Runs
Configure Carriers, Origins, and Related Settings
Carriers, origin addresses, stores, filters, rules, templates, and automations: the CLI entry points and where the web app takes over.
Doctor and Schema Introspection
Check the machine before you ship, and ask the CLI to describe any command's request and response shapes.
Batches and Unattended Runs with the CLI
Run the CLI unattended: credentials, idempotency, authorization, and a cost-free smoke test of the purchase path.
Troubleshooting
Symptoms matched to exit codes and error codes, what each means, and where to go next.
Recipes
Find the Cheapest Rate, Then Buy the Label
Rate shop one order and buy the cheapest label, rehearsed first.
Rehearse a Purchase with Dry-Run
Rehearse a purchase, void, or shipment creation without spending anything.
Keep a Batch Read Read-Only
Phrase a batch read so the money-keyword check does not mistake it for shipping work.
See What Is Ready to Ship
See what the product considers ready to ship without guessing status names.
Commands
postsale account
Who you are signed in as, what your credential can do, and which environment you are pointed at.
postsale auth
Sign in with a browser or a device code, sign out, and check which credential is active.
postsale automation
List, create, update, and delete automation workflows and webhooks. Needs a signed-in session.
postsale carriers
Add, validate, update, and remove carrier accounts, including the house USPS account's return address.
postsale continue
Pick up a previous conversation and keep talking to the agent.
postsale conversations
List the conversations stored on this machine so you can continue one.
postsale doctor
Check credentials, network, API access, carriers, and origin addresses before you ship; pre-flight mode for unattended runs.
postsale filters
Saved order searches: list, create, update, and delete.
postsale labels
Buy labels one shipment at a time, reprint an existing label, and void a label you no longer need.
postsale licenses
Show the Postsale license and the bundled third-party notices, offline.
postsale manifest
End-of-day carrier manifests: list what is pending and close the day.
postsale orders
Search, read, create, update, tag, and recover orders, and ask the work queue what is ready to ship.
postsale origin-addresses
Manage the addresses your shipments ship from.
postsale reports
Order counts, shipment counts, revenue, top items, and cost by carrier.
postsale run (command stub)
Run the natural-language agent: authorize money-moving work, rehearse with dry-run, stream events, or continue a conversation.
postsale saved-queries
Save, list, recall, run, and delete named intents stored on this machine.
postsale schema
Describe any command's request and response shapes from the local catalog, no sign-in needed.
postsale shipments
List, read, create, update, and bulk-edit shipments, and get rate quotes.
postsale shipping-rules
List, create, update, and delete the rules that build shipments automatically.
postsale stores
List your connected stores.
postsale templates
Manage label, packing-slip, invoice and email templates as records: list, copy, move and back them up; author them in the app with the Liquid guide.
postsale traces
List, inspect, export, and purge the execution traces the CLI keeps on this machine.
postsale upgrade
Install the latest release in place. Not yet available during the invitation release; new versions arrive by invitation.
Reference
Agent Tools Reference
Every tool the agent can call, with its safety class and dry-run behaviour.
CLI-Only Commands (Not in schema --list)
Commands that exist only in the CLI, with no API operation behind them.
Environment Variables
Every POSTSALE_ variable, what it controls, and its default.
Exit Codes
What each exit code means and how a script or an agent should react.
Limits and Honesty
Known limits of the CLI and the platform, stated plainly.
Safety Classes (Reference)
The four safety classes and what each requires before it runs.
Schema Slugs Reference
Every schema slug the CLI can describe, grouped by command.
For Agent Hosts
Agent Documentation
Where an agent host starts: the contract, the quick reference, the tools, the error table, and the honesty rules.
Agent Quick Reference
The one-page reference for driving the CLI from an agent: flags, envelopes, gates, and codes.
Agent Tools Catalog
Every tool the natural-language agent can call, grouped by what it touches.
Agent Error Recovery
What each error code means and the recovery an agent should take.
Honesty Contracts
The promises the CLI keeps about what it did, did not do, and could not verify.
Agent Intent Recipes
Intent patterns that work well for agents, and the wording that trips the gates.
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.