Quickstart
Install the Warp Agent CLI
Requires Node.js 18 or later.
npm install -g @warpfreight/cli-agentThe WARP ASCII logo and command list appear automatically after install.
Create your account
New to Warp? Run warp-agent signup — prompts for email, password, and company name. Creates your account instantly, no sales call. Saves your API key to ~/.warp/config.json — every command after this uses that key automatically.
warp-agent signupAlready have a Warp account? Run warp-agent login instead.
Get a freight quote
Pick a mode (ltl, van, box-truck, ftl) and pass origin ZIP, destination ZIP, and shipment details. Quote IDs (PRICING_xxx) are stable for 15 minutes.
warp-agent ltl quote 90007 60601 \
--pallets 2 --weight 600 --dims 48x40x48 --date 2026-05-01Returns the Warp rate plus all market carriers sorted by price:
{
"warp_quote_id": "PRICING_abc-123",
"warp_price": 955.93,
"transit_days": 5,
"options": [
{ "carrier": "Warp Technology", "rate": 955.93, "transit_days": 5, "option_id": "PRICING_abc-123" },
{ "carrier": "GlovaLink", "rate": 598.54, "transit_days": 8, "option_id": "OPT_..." },
{ "carrier": "Forward", "rate": 799.30, "transit_days": 5, "option_id": "OPT_..." }
]
}Book the shipment
Pass the quote ID with full pickup and delivery addresses. Every address field is required: street, city, state, ZIP, contact name, phone, email.
warp-agent book PRICING_abc-123 \
--pickup-company "Acme Logistics" \
--pickup-street "123 Main St" --pickup-city "Los Angeles" \
--pickup-state "CA" --pickup-zip "90001" \
--pickup-contact "John Doe" --pickup-phone "2135550123" \
--pickup-email "john@acme.com" \
--delivery-company "Client Co" \
--delivery-street "456 Oak Ave" --delivery-city "Chicago" \
--delivery-state "IL" --delivery-zip "60601" \
--delivery-contact "Jane Smith" --delivery-phone "3125550456" \
--delivery-email "jane@client.com" \
--reference "PO-12345"Optional: --pickup-window, --delivery-window (default 08:00–17:00), --reference for your PO number.
Track your shipment
Track by shipment ID or tracking number (S-XXXXX-XXXX format).
warp-agent track S-80215-2616Full event history:
warp-agent events S-80215-2616Every booking also appears in customer.wearewarp.com and at tracking.wearewarp.com.
Command reference
warp-agent signupCreate a new Warp account and save API key to ~/.warp/config.jsonwarp-agent loginLog in to an existing Warp account and save API key to ~/.warp/config.jsonwarp-agent whoamiShow current account info and payment statuswarp-agent ltl quoteQuote LTL with dims, weight, commoditywarp-agent ltl quote 90007 60601 --pallets 2 --weight 600 --dims 48x40x48 --date 2026-05-01warp-agent van quoteQuote cargo van (1-3 pallets, up to 3,500 lbs)warp-agent van quote 90001 90210 --pallets 1 --weight 400 --date 2026-05-01warp-agent box-truck quoteQuote 26-foot box truck (1-12 pallets)warp-agent box-truck quote 90001 10001 --pallets 6 --weight 800 --date 2026-05-01warp-agent ftl quoteQuote full truckload (53-foot dry van)warp-agent ftl quote 90001 10001 --date 2026-05-01warp-agent bookBook a quoted shipmentwarp-agent book PRICING_xxx [address flags] | jq '.trackingNumber'warp-agent trackTrack by shipment ID or tracking numberwarp-agent track S-80215-2616warp-agent eventsFull event history for a shipmentwarp-agent events S-80215-2616warp-agent cancelCancel a booking before pickupwarp-agent bookingsList recent bookings (--limit N)warp-agent bookings --limit 10warp-agent invoiceGet invoice details for a shipmentwarp-agent documentsBOL, POD, customs docs for a shipmentwarp-agent rate-cardShow your standard rate cardwarp-agent quote-historyList past quote requestswarp-agent multistop quoteMulti-stop FTL (one truck, multiple stops)warp-agent multistop quote body.jsonwarp-agent multistop bookBook a quoted multi-stop FTLwarp-agent analyticsRevenue and booking counts by source (cli vs mcp)warp-agent statusCheck API health (no auth required)warp-agent logoutRemove saved credentials from ~/.warp/config.jsonOutput format
JSON by default. Pipe into jq or any JSON parser.
jsonDefault. Clean JSON for scripting and piping.--format tableHuman-readable table output.warp-agent ltl quote 90001 60601 --pallets 2 --weight 600 --dims 48x40x48 --date 2026-05-01 \
| jq '.options | min_by(.rate)'Key design decisions
- No API key in scripts. Key is saved on login, never exposed. Every command reads from
~/.warp/config.json. - All-inclusive pricing. Rates include liftgate, residential delivery, appointment scheduling, and limited access surcharges.
- Idempotent quotes. PRICING_xxx IDs are stable for 15 minutes — retry booking without re-quoting.
- Direct API. Calls
gw.wearewarp.comdirectly. No proxy, no wrapper. - Self-provisioning.
warp-agent signupcreates a Warp account in seconds.warp-agent loginauthenticates an existing account. Both save the key to~/.warp/config.json. - Account parity. Every booking appears in customer.wearewarp.com with full history, invoices, and documents.
Ready to ship?
One install, one login, you're moving freight in under two minutes.