Skip to content
This repository has been archived by the owner on Mar 13, 2021. It is now read-only.

Commit

Permalink
fixup cli command
Browse files Browse the repository at this point in the history
  • Loading branch information
pierce-h committed Aug 12, 2020
1 parent 00056e5 commit e8718cb
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 38 deletions.
74 changes: 37 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,37 +21,37 @@
<!-- usage -->
```sh-session
$ npm install -g @shipengine/connect-cli
$ shipengine COMMAND
$ connect COMMAND
running command...
$ shipengine (-v|--version|version)
@shipengine/connect-cli/1.0.1 linux-x64 node-v12.18.1
$ shipengine --help [COMMAND]
$ connect (-v|--version|version)
@shipengine/connect-cli/1.0.1 darwin-x64 node-v12.16.2
$ connect --help [COMMAND]
USAGE
$ shipengine COMMAND
$ connect COMMAND
...
```
<!-- usagestop -->

# Commands

<!-- commands -->
* [`shipengine help [COMMAND]`](#shipengine-help-command)
* [`shipengine info`](#shipengine-info)
* [`shipengine login`](#shipengine-login)
* [`shipengine logout`](#shipengine-logout)
* [`shipengine new [PATH]`](#shipengine-new-path)
* [`shipengine publish`](#shipengine-publish)
* [`shipengine start`](#shipengine-start)
* [`shipengine test`](#shipengine-test)
* [`shipengine whoami`](#shipengine-whoami)
* [`connect help [COMMAND]`](#connect-help-command)
* [`connect info`](#connect-info)
* [`connect login`](#connect-login)
* [`connect logout`](#connect-logout)
* [`connect new [PATH]`](#connect-new-path)
* [`connect publish`](#connect-publish)
* [`connect start`](#connect-start)
* [`connect test`](#connect-test)
* [`connect whoami`](#connect-whoami)

## `shipengine help [COMMAND]`
## `connect help [COMMAND]`

display help for shipengine
display help for connect

```
USAGE
$ shipengine help [COMMAND]
$ connect help [COMMAND]
ARGUMENTS
COMMAND command to show help for
Expand All @@ -62,61 +62,61 @@ OPTIONS

_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.2.0/src/commands/help.ts)_

## `shipengine info`
## `connect info`

list info for an app

```
USAGE
$ shipengine info
$ connect info
OPTIONS
-h, --help show help for the info command
```

_See code: [src/commands/info.ts](https://github.com/ShipEngine/connect-cli/blob/v1.0.1/src/commands/info.ts)_

## `shipengine login`
## `connect login`

login with your connect API key

```
USAGE
$ shipengine login
$ connect login
OPTIONS
-h, --help show help for the auth:login command
ALIASES
$ shipengine login
$ connect login
```

_See code: [src/commands/login.ts](https://github.com/ShipEngine/connect-cli/blob/v1.0.1/src/commands/login.ts)_

## `shipengine logout`
## `connect logout`

clears the local connect API key

```
USAGE
$ shipengine logout
$ connect logout
OPTIONS
-h, --help show help for the auth:logout command
ALIASES
$ shipengine logout
$ connect logout
```

_See code: [src/commands/logout.ts](https://github.com/ShipEngine/connect-cli/blob/v1.0.1/src/commands/logout.ts)_

## `shipengine new [PATH]`
## `connect new [PATH]`

create a new package to develop a custom ShipEngine app

```
USAGE
$ shipengine new [PATH]
$ connect new [PATH]
ARGUMENTS
PATH path to new package (defaults to current directory)
Expand All @@ -127,21 +127,21 @@ OPTIONS
-y, --yes skips the questions and uses the defaults (carrier|Javascript|yaml)
ALIASES
$ shipengine init
$ connect init
EXAMPLE
$ shipengine new
```

_See code: [src/commands/new.ts](https://github.com/ShipEngine/connect-cli/blob/v1.0.1/src/commands/new.ts)_

## `shipengine publish`
## `connect publish`

publish your app

```
USAGE
$ shipengine publish
$ connect publish
OPTIONS
-h, --help show help for the publish command
Expand All @@ -154,13 +154,13 @@ EXAMPLE

_See code: [src/commands/publish.ts](https://github.com/ShipEngine/connect-cli/blob/v1.0.1/src/commands/publish.ts)_

## `shipengine start`
## `connect start`

start a local web server to develop your app interactively

```
USAGE
$ shipengine start
$ connect start
OPTIONS
-h, --help show help for the apps:start commands
Expand All @@ -169,13 +169,13 @@ OPTIONS

_See code: [src/commands/start.ts](https://github.com/ShipEngine/connect-cli/blob/v1.0.1/src/commands/start.ts)_

## `shipengine test`
## `connect test`

test your app

```
USAGE
$ shipengine test
$ connect test
OPTIONS
-d, --debug logs additional debug information
Expand All @@ -192,19 +192,19 @@ EXAMPLES

_See code: [src/commands/test.ts](https://github.com/ShipEngine/connect-cli/blob/v1.0.1/src/commands/test.ts)_

## `shipengine whoami`
## `connect whoami`

display the current logged in user

```
USAGE
$ shipengine whoami
$ connect whoami
OPTIONS
-h, --help show help for the auth:whoami command
ALIASES
$ shipengine whoami
$ connect whoami
```

_See code: [src/commands/whoami.ts](https://github.com/ShipEngine/connect-cli/blob/v1.0.1/src/commands/whoami.ts)_
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@
"main": "lib/index.js",
"oclif": {
"commands": "./lib/commands",
"bin": "shipengine",
"bin": "connect",
"plugins": [
"@oclif/plugin-help",
"@oclif/plugin-not-found"
Expand Down

0 comments on commit e8718cb

Please sign in to comment.