Skip to content

Quick Start

Install the CLI, sign in, pick an environment, run your first reads, and rehearse before you spend money.

Updated September 3, 20261 min readPostsale CLI

Available by invitation

The Postsale CLI is in an invitation-only release. Your invitation includes a signed program for your platform and its checksum, and new versions reach you the same way until the public release channel opens. To request access, email support@postsale.com.

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 unattendedBatches and Unattended Runs
Hosting an agentAgent 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.

bash
postsale --version    # prints the CLI's own semver

2. Sign in

bash
postsale auth login                 # or: --no-browser
postsale auth status

Details: Sign In and Credentials.

3. Preflight and first reads

bash
postsale doctor --human
postsale account whoami
postsale orders search --query "orders from last 7 days" --page-size 5 --human

4. Ask the agent a question

Set ANTHROPIC_API_KEY (or ANTHROPIC_AUTH_TOKEN) or OPENAI_API_KEY, then:

bash
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?

bash
postsale orders work-queue --human

No LLM key needed for this one. The same answer via the agent, if you set a key in step 4:

bash
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:

bash
postsale run --dry-run "Ship order <order_id> with the cheapest carrier"

Tip

To rehearse the real purchase path for free, set POSTSALE_TEST_LABEL_MODE=1 in the shell. Every shipment you create is stamped test_label: true, purchases refuse any shipment that is not a test shipment, and the labels you get back are watermarked and never billed. Walkthrough: Test Without Spending.

Additional Reading

Related

Keep reading