ShipEngine Connect CLI

⚠ WARNING: This is an internal package

Using this package directly is discouraged and unsupported. Instead, you should install @shipengine/connect which uses this package under the hood. See our documentation for more information.

• ShipEngine Connect CLI
• Usage
• Commands

Usage

$ npm install -g @shipengine/connect-cli
$ connect COMMAND
running command...
$ connect (-v|--version|version)
@shipengine/connect-cli/2.15.2 darwin-x64 node-v12.18.2
$ connect --help [COMMAND]
USAGE
  $ connect COMMAND
...

Commands

• connect apps
• connect env:get NAME-1 ... NAME-N
• connect env:list
• connect env:set NAME-1=VALUE ... NAME-N=VALUE
• connect env:unset NAME-1 ... NAME-N
• connect help [COMMAND]
• connect info
• connect init [PATH]
• connect login
• connect logout
• connect logs
• connect pack
• connect publish
• connect start
• connect test
• connect whoami

connect apps

List your apps

USAGE
  $ connect apps

OPTIONS
  -h, --help  Show help for the apps commands

See code: src/commands/apps.ts

connect env:get NAME-1 ... NAME-N

Get environment variables for an app

USAGE
  $ connect env:get NAME-1 ... NAME-N

ARGUMENTS
  NAME-1 ... NAME-N  the environment variable name(s). e.g. FOO (note: name will always be UPPERCASED)

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

ALIASES
  $ connect get

See code: src/commands/env/get.ts

connect env:list

List environment variables for an app

USAGE
  $ connect env:list

OPTIONS
  -f, --format=table|dotenv  [default: table] specify output format
  -h, --help                 show help for the env command

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

connect env:set NAME-1=VALUE ... NAME-N=VALUE

Set environment variables for an app

USAGE
  $ connect env:set NAME-1=VALUE ... NAME-N=VALUE

ARGUMENTS
  NAME-1=VALUE ... NAME-N=VALUE  the environment variable(s) name=value. e.g. FOO=bar (note: name will always be
                                 UPPERCASED)

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

ALIASES
  $ connect set

See code: src/commands/env/set.ts

connect env:unset NAME-1 ... NAME-N

Unset (delete) environment variables from an app

USAGE
  $ connect env:unset NAME-1 ... NAME-N

ARGUMENTS
  NAME-1 ... NAME-N  the environment variable name(s). e.g. FOO (note: name will always be UpperCased)

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

ALIASES
  $ connect unset

See code: src/commands/env/unset.ts

connect help [COMMAND]

display help for connect

USAGE
  $ connect help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

connect info

Get the current information about your app

USAGE
  $ connect info

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

See code: src/commands/info.ts

connect init [PATH]

Create a new package to develop a custom ShipEngine app

USAGE
  $ connect init [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
  $ connect new

EXAMPLE
  $ connect init

See code: src/commands/init.ts

connect login

Login with your connect API key

USAGE
  $ connect login

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

ALIASES
  $ connect login

See code: src/commands/login.ts

connect logout

Clears the local connect API key

USAGE
  $ connect logout

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

ALIASES
  $ connect logout

See code: src/commands/logout.ts

connect logs

Get the logs for your app

USAGE
  $ connect logs

OPTIONS
  -a, --all                 Show internal logs along with the app developer related ones
  -f, --format=default|raw  [default: default] The format the logs get shown in
  -h, --help                Show help for the logs command
  -l, --lines=lines         [default: 500] The number of lines of logs to show from the server, max of 1500

See code: src/commands/logs.ts

connect pack

Package your app

USAGE
  $ connect pack

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

EXAMPLE
  $ connect pack

See code: src/commands/pack.ts

connect publish

Packages and publishes your app to the dev server

USAGE
  $ connect publish

OPTIONS
  -h, --help        Show help for the publish command
  -n, --no-watch    Does not track the status of the deployment
  -s, --skip-tests  Skip running the test before publishing

EXAMPLE
  $ connect publish

See code: src/commands/publish.ts

connect start

Start a local web server to develop your app interactively

USAGE
  $ connect start

OPTIONS
  -h, --help       Show help for the start commands
  -p, --port=port  [default: 3000] The port that the app will run on

See code: src/commands/start.ts

connect test

Test your app

USAGE
  $ connect 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
  $ connect test
  $ connect test --grep rateShipment

See code: src/commands/test.ts

connect whoami

Display the current logged in user

USAGE
  $ connect whoami

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

ALIASES
  $ connect whoami

See code: src/commands/whoami.ts