WARP CLI

A command-line tool for managing freight shipments through the WARP API.

Installation

npm

npm install -g @wearewarp/cli

Homebrew

brew tap wearewarp/warp
brew install warp-cli

Quick Start

# Authenticate with your API key
warp login --api-key YOUR_API_KEY

# Get a shipping quote
warp quote \
  --pickup-date 2026-04-01 \
  --pickup-zip 90210 \
  --delivery-zip 10001 \
  --item-height 48 --item-length 48 --item-width 40 \
  --item-size-unit IN \
  --item-weight 500 --item-weight-unit lbs \
  --item-qty 1

# Book a shipment
warp book --quote-id <QUOTE_ID> --from-file booking.json

# Track a shipment
warp track <TRACKING_NUMBER>

# List your shipments
warp shipments

Commands

Authentication

| Command | Description | |---------|-------------| | warp login | Authenticate interactively | | warp login --api-key <key> | Authenticate with API key | | warp logout | Remove stored credentials | | warp whoami | Show current auth status |

Freight Operations

| Command | Description | |---------|-------------| | warp quote | Get a freight shipping quote | | warp book | Book a shipment from a quote | | warp track <numbers> | Track shipments by tracking number | | warp shipments | List all shipments | | warp events <shipmentId> | View shipment events | | warp invoice <orderId> | View order invoice | | warp documents <orderId> | List order documents | | warp quote-history | View past quotes |

Configuration

| Command | Description | |---------|-------------| | warp config get | Show current configuration | | warp config set env staging | Switch to staging environment | | warp config set env production | Switch to production environment | | warp config set output json | Set default output format | | warp config reset | Reset to default settings |

Output Formats

All freight commands support --output (-o) flag:

• table (default) - Human-readable table with colors
• json - Raw JSON response
• csv - CSV format

warp shipments --output json
warp shipments -o csv

Using JSON Files

For complex requests, use --from-file to provide a JSON request body:

# Quote from file
warp quote --from-file quote-request.json

# Book from file
warp book --quote-id <ID> --from-file booking.json

Environments

| Environment | Base URL | |-------------|----------| | Production | https://gw.wearewarp.com/api/v1 | | Staging | https://stg.wearewarp.com/api/v1 |

Configuration

Config is stored at ~/.config/warp-cli/config.json.

Development

# Build + link globally for testing
./scripts/dev.sh

# Build only
./scripts/build.sh

# Run locally without linking
./bin/dev.js --help
./bin/dev.js quote --help

Release

# Full release: bump version -> build -> publish npm -> GitHub Releases -> update Homebrew
./scripts/release.sh patch    # 0.1.0 -> 0.1.1
./scripts/release.sh minor    # 0.1.0 -> 0.2.0
./scripts/release.sh major    # 0.1.0 -> 1.0.0

# Or run individual steps:
./scripts/publish-npm.sh        # npm only
./scripts/build-tarballs.sh     # standalone tarballs
./scripts/publish-github.sh     # upload tarballs to GitHub Releases
./scripts/update-homebrew.sh    # update Homebrew formula

Config (for GitHub Releases + Homebrew)

cp .env.example .env
# Edit .env with your values - scripts auto-load it
# Requires: gh CLI (brew install gh)

API Documentation

Full API documentation: https://developer.wearewarp.com/docs/freight/

Support

Contact: [email protected]