ShipEngine Connect CLI

Installing

You can install the Connect CLI tool by running the following command from your terminal:

Copy

Copied

npm install --global @shipengine/connect

After the installation has been completed you can test to make sure it is working by running:

Copy

Copied

shipengine-connect --version

Log In

Api KEY

In order to publish, deploy, and test in our hosted environment you will need a ShipEngine Connect API Key.
This is not the same as a ShipEngine API Key, which is used to make requests to the ShipEngine APIs

Please contact the ShipEngine Connect Team to obtain a ShipEngine Connect API Key.

You can then use the command:

Copy

Copied

shipengine-connect login

and you will be prompted to enter your API Key:

Copy

Copied

shipengine-connect login
Please enter your API key: []

After entering your API key and hitting Enter you should see a successful login message:

Copy

Copied

shipengine-connect login
Please enter your API key: **************************
Verifying account... done
You have logged in with a Connect API key