All Projects → jessfraz → ship

jessfraz / ship

Licence: MIT license
Command line tool to track packages using the AfterShip API.

Programming Languages

go
31211 projects - #10 most used programming language
Makefile
30231 projects
Dockerfile
14818 projects

ship

make-all make-image GoDoc Github All Releases

Command line tool to track packages using the AfterShip API.

Table of Contents

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)
Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].