@shipengine/cli v0.0.14

shipengine-cli

Command-line tool for working with your ShipEngine account

🚧 UNDER CONSTRUCTION 🚧

This app is still being developed and is not ready for public use yet.

• shipengine-cli
• 🚧 UNDER CONSTRUCTION 🚧
• Usage
• Commands

Usage

$ npm install -g @shipengine/cli
$ shipengine COMMAND
running command...
$ shipengine (-v|--version|version)
@shipengine/cli/0.0.14 linux-x64 node-v12.18.1
$ shipengine --help [COMMAND]
USAGE
  $ shipengine COMMAND
...

Commands

• shipengine apps:info
• shipengine apps:new [PATH]
• shipengine apps:publish
• shipengine apps:test
• shipengine auth:login
• shipengine auth:logout
• shipengine auth:whoami
• shipengine carriers:list
• shipengine help [COMMAND]

shipengine apps:info

list info for an app

USAGE
  $ shipengine apps:info

OPTIONS
  -h, --help  show help for the apps:info commands

See code: src/commands/apps/info.ts

shipengine apps:new [PATH]

create a new package to develop a custom ShipEngine app

USAGE
  $ shipengine apps:new [PATH]

ARGUMENTS
  PATH  path to new package (defaults to current directory)

OPTIONS
  -f, --force  overwrite existing files
  -h, --help   show help for the apps:new command
  -y, --yes    skips the questions and uses the defaults (carrier|Javascript|yaml)

EXAMPLE
  $ shipengine apps:new

See code: src/commands/apps/new.ts

shipengine apps:publish

publish your app

USAGE
  $ shipengine apps:publish

OPTIONS
  -h, --help        show help for the apps:publish command
  -s, --skip-tests  skip running the test before publishing
  -w, --watch       check the status of the deployment until complete

EXAMPLE
  $ shipengine apps:publish

See code: src/commands/apps/publish.ts

shipengine apps:test

test your app

USAGE
  $ shipengine apps:test

OPTIONS
  -d, --debug            logs additional debug information
  -f, --fail-fast        stop running the test suite on the first failed test
  -g, --grep=grep        only run test that match the given string
  -h, --help             show help for the apps:test command
  -r, --retries=retries  specify the retries for all the test
  -t, --timeout=timeout  specify the timeout for all the test

EXAMPLES
  $ shipengine apps:test
  $ shipengine apps:test --grep rateShipment

See code: src/commands/apps/test.ts

shipengine auth:login

login with your ShipEngine API key

USAGE
  $ shipengine auth:login

OPTIONS
  -h, --help  show help for the auth:login command

ALIASES
  $ shipengine login

See code: src/commands/auth/login.ts

shipengine auth:logout

clears the local API key

USAGE
  $ shipengine auth:logout

OPTIONS
  -h, --help  show help for the auth:logout command

ALIASES
  $ shipengine logout

See code: src/commands/auth/logout.ts

shipengine auth:whoami

display the current logged in user

USAGE
  $ shipengine auth:whoami

OPTIONS
  -h, --help  show help for the auth:whoami command

ALIASES
  $ shipengine whoami

See code: src/commands/auth/whoami.ts

shipengine carriers:list

list the carriers associated with your account

USAGE
  $ shipengine carriers:list

OPTIONS
  -h, --help  show help for the carriers:list command

ALIASES
  $ shipengine list

See code: src/commands/carriers/list.ts

shipengine help [COMMAND]

display help for shipengine

USAGE
  $ shipengine help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help