ship

Command line tool to track packages using the AfterShip API.

<!-- START doctoc generated TOC please keep comment here to allow auto update --> <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->

Table of Contents

• Installation
  • Binaries
  • Via Go
  • Running with Docker
• Usage
  • Create a Shipment
  • Get a Shipment
  • List Shipments
  • Delete a Shipment

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

Installation

Binaries

For installation instructions from binaries please visit the Releases Page.

Via Go

$ go get github.com/jessfraz/ship

Running with Docker

$ docker run --rm -it \
    -v /etc/localtime:/etc/localtime:ro \
    --name ship \
    -e "AFTERSHIP_API_KEY=your_api_key" \
    r.j3ss.co/ship

Usage

$ ship -h
ship -  Command line tool to track packages using the AfterShip API.

Usage: ship <command>

Flags:

  -d        enable debug logging (default: false)
  --apikey  AfterShip API Key (or env var AFTERSHIP_API_KEY) (default: <none>)

Commands:

  create   Create a shipment.
  get      Get details for a shipment.
  ls       List shipments.
  rm       Delete a shipment.
  version  Show the version information.

Create a Shipment

$ ship create -h
Usage: ship create [OPTIONS] TRACKING_NUMBER

Create a shipment.

Flags:

  --apikey  AfterShip API Key (or env var AFTERSHIP_API_KEY) (default: <none>)
  -d        enable debug logging (default: false)

Get a Shipment

$ ship get -h
Usage: ship get [OPTIONS] TRACKING_NUMBER

Get details for a shipment.

Flags:

  --apikey  AfterShip API Key (or env var AFTERSHIP_API_KEY) (default: <none>)
  -d        enable debug logging (default: false)

List Shipments

$ ship ls -h
Usage: ship ls 

List shipments.

Flags:

  --apikey  AfterShip API Key (or env var AFTERSHIP_API_KEY) (default: <none>)
  -d        enable debug logging (default: false)

Delete a Shipment

$ ship rm -h
Usage: ship rm [OPTIONS] TRACKING_NUMBER

Delete a shipment.

Flags:

  --apikey  AfterShip API Key (or env var AFTERSHIP_API_KEY) (default: <none>)
  -d        enable debug logging (default: false)