@shipengine/integration-platform-cli v0.0.22

ShipEngine Integration Platform CLI

Command-line tool for building ShipEngine Integration Platform apps

• ShipEngine Integration Platform CLI
• Usage
• Commands

Usage

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

Commands

• shipengine help [COMMAND]
• shipengine info
• shipengine login
• shipengine logout
• shipengine new [PATH]
• shipengine publish
• shipengine test
• shipengine whoami

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

shipengine info

list info for an app

USAGE
  $ shipengine info

OPTIONS
  -h, --help  show help for the info command

See code: src/commands/info.ts

shipengine login

login with your integrations API key

USAGE
  $ shipengine login

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

ALIASES
  $ shipengine login

See code: src/commands/login.ts

shipengine logout

clears the local integrations API key

USAGE
  $ shipengine logout

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

ALIASES
  $ shipengine logout

See code: src/commands/logout.ts

shipengine new [PATH]

create a new package to develop a custom ShipEngine app

USAGE
  $ shipengine new [PATH]

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

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

ALIASES
  $ shipengine init

EXAMPLE
  $ shipengine new

See code: src/commands/new.ts

shipengine publish

publish your app

USAGE
  $ shipengine publish

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

EXAMPLE
  $ shipengine publish

See code: src/commands/publish.ts

shipengine test

test your app

USAGE
  $ shipengine 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 test command
  -r, --retries=retries  specify the retries for all the test
  -t, --timeout=timeout  specify the timeout for all the test

EXAMPLES
  $ shipengine test
  $ shipengine test --grep rateShipment

See code: src/commands/test.ts

shipengine whoami

display the current logged in user

USAGE
  $ shipengine whoami

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

ALIASES
  $ shipengine whoami

See code: src/commands/whoami.ts