CLI

Ship packages from your terminal. Compare rates, buy labels, and track shipments with a single command — no browser required.

@atoship/cli

v1.0.1

6 commands

Before

Open carrier website → enter addresses → compare rates across tabs → download label → copy-paste tracking number

After

ship rate --from 90001 --to 10001 --weight 2oz --cheapest

Installation

Install globally — the ship command will be available system-wide.

npm install -g @atoship/cli

Setup — save your API key

Get your key from Dashboard → Settings → API Keys. Use ak_live_ for production, ak_test_ for development (test labels are free).

# Save your API key (stored in ~/.config/atoship/config.json)
ship config set-key ak_live_your_key_here

# Or use an environment variable
export ATOSHIP_API_KEY=ak_live_your_key_here

Commands

6 commands covering the full shipping workflow.

ship rate

Compare live rates from USPS, FedEx, and UPS

ship rate --from "LA, CA 90001" --to "NY, NY 10001" --weight 2oz --cheapest

ship buy

Purchase a shipping label and get the tracking number

ship buy --rate rate_abc123 --from "John|123 Main St|LA|CA|90001" --to "Jane|456 Oak Ave|NY|NY|10001"

ship track

Track a package with full event history

ship track 9400111899223456789012 --watch

ship labels

List and filter your shipping labels

ship labels --status shipped --carrier FEDEX

ship balance

View wallet balance and account info

ship balance

ship config

Manage API key and CLI configuration

ship config set-key ak_live_your_key_here

Compare rates from USPS, FedEx, and UPS. Supports city/state, ZIP, or full address input.

# Compare all carriers
ship rate --from "Los Angeles, CA 90001" --to "New York, NY 10001" --weight 2oz

# Cheapest per carrier only
ship rate --from-zip 90001 --to-zip 10001 --weight 1lb --cheapest

# Filter by carrier
ship rate --from "LA, CA" --to "NY, NY" --weight 16oz --carrier USPS,FEDEX

# With dimensions
ship rate --from "LA, CA" --to "NY, NY" --weight 2oz --length 12 --width 8 --height 6

Why use the CLI?

Fast

One command from order to label. No browser, no clicking, no waiting for pages to load.

Scriptable

Pipe --json output into jq, scripts, or webhooks. Automate label purchase in CI/CD pipelines.

Watch mode

ship track --watch polls every 5 minutes and alerts you when a package is delivered.

Configuration

Variable	Description
`ATOSHIP_API_KEY`	Your atoship API key — overrides saved config
`ATOSHIP_BASE_URL`	Custom API base URL (default: https://atoship.com)

Config file saved at ~/.config/atoship/config.json when using ship config set-key.

Need help? Email [email protected] — we respond within one business day.