@jarsmohella/lorry

A CLI for interacting with the ShipEngine API

Usage no npm install needed!

<script type="module">
  import jarsmohellaLorry from 'https://cdn.skypack.dev/@jarsmohella/lorry';
</script>

README

Lorry CLI

Lorry

$ lorry
  _
 | |       ___    _ __   _ __   _   _
 | |      / _ \  | '__| | '__| | | | |
 | |___  | (_) | | |    | |    | |_| |
 |_____|  \___/  |_|    |_|     \__, |
                                |___/
Usage: lorry [options] [command]

A CLI for interacting with the ShipEngine API

Options:
  -V, --version       output the version number
  -h, --help          display help for command

Commands:
  login               Log in to the ShipEngine API
  logout              Log out of the ShipEngine API
  carriers <command>  Execute actions against your ShipEngine carriers
  help [command]      display help for command

Usage

$ npm install -g @jarsmohella/lorry
$ lorry COMMAND
running command...
$ lorry --version
1.0.0
$ lorry --help [COMMAND]
USAGE
  $ lorry COMMAND
...

Testing

$ npm run test

Linting

$ npm run lint

Formatting

$ npm run format

Commands

lorry login

Login with your ShipEngine API key

USAGE
  $ lorry login

OPTIONS
  -h, --help  Show help for the login command

ALIASES
  $ lorry login

See code: src\auth.ts

lorry logout

Clears the local ShipEngine API key

USAGE
  $ lorry logout

OPTIONS
  -h, --help  Show help for the logout command

ALIASES
  $ connect logout

See code: src\auth.ts

lorry carriers <COMMAND>

Execute actions against your ShipEngine carriers

USAGE
  $ lorry carriers ls

OPTIONS
  -h, --help  Show help for the logs command

See code: src\carriers.ts