Centro de ayudaGitHub

CLI

Envía paquetes desde tu terminal. Compara tarifas, compra etiquetas y rastrea envíos con un solo comando, sin necesidad de navegador.

@atoship/cli
v1.0.1
6 comandos

Antes

Abrir el sitio del transportista → ingresar direcciones → comparar tarifas entre pestañas → descargar etiqueta → copiar y pegar el número de rastreo

Después

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

Instalación

Instala de forma global: el comando ship quedará disponible en todo el sistema.

npm install -g @atoship/cli

Configuración: guarda tu clave API

Obtén tu clave en Dashboard → Settings → API Keys. Usa ak_live_ para producción y ak_test_ para desarrollo (las etiquetas de prueba son gratis).

# Guarda tu clave API (se almacena en ~/.config/atoship/config.json)
ship config set-key ak_live_your_key_here

# O usa una variable de entorno
export ATOSHIP_API_KEY=ak_live_your_key_here

Comandos

6 comandos que cubren todo el flujo de envío.

ship rate

Compara tarifas en vivo de USPS, FedEx y UPS

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

Compra una etiqueta de envío y obtén el número de rastreo

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

Rastrea un paquete con el historial completo de eventos

ship track 9400111899223456789012 --watch
ship labels

Lista y filtra tus etiquetas de envío

ship labels --status shipped --carrier FEDEX
ship balance

Consulta el saldo de tu billetera y la información de la cuenta

ship balance
ship config

Administra la clave API y la configuración del CLI

ship config set-key ak_live_your_key_here

Compara tarifas de USPS, FedEx y UPS. Acepta ciudad/estado, código postal o dirección completa.

# Compara todos los transportistas
ship rate --from "Los Angeles, CA 90001" --to "New York, NY 10001" --weight 2oz

# Solo la tarifa más barata por transportista
ship rate --from-zip 90001 --to-zip 10001 --weight 1lb --cheapest

# Filtra por transportista
ship rate --from "LA, CA" --to "NY, NY" --weight 16oz --carrier USPS,FEDEX

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

¿Por qué usar el CLI?

Rápido

Un solo comando del pedido a la etiqueta. Sin navegador, sin clics y sin esperar a que carguen las páginas.

Scriptable

Canaliza la salida --json hacia jq, scripts o webhooks. Automatiza la compra de etiquetas en pipelines de CI/CD.

Modo watch

ship track --watch consulta cada 5 minutos y te avisa cuando un paquete es entregado.

Configuración

VariableDescripción
ATOSHIP_API_KEYTu clave API de atoship: tiene prioridad sobre la configuración guardada
ATOSHIP_BASE_URLURL base de la API personalizada (predeterminada: https://atoship.com)

El archivo de configuración se guarda en ~/.config/atoship/config.json al usar ship config set-key.

¿Necesitas ayuda? Escribe a [email protected]: respondemos en un día hábil.

atoship © 2026