Merge pull request #81 from hackmdio/release/2.3.1

Release 2.3.1

README.md

@@ -28,7 +28,7 @@ $ npm install -g @hackmd/hackmd-cli
 $ hackmd-cli COMMAND
 running command...
 $ hackmd-cli (--version|-v)
-@hackmd/hackmd-cli/2.3.0 darwin-arm64 node-v18.14.2
+@hackmd/hackmd-cli/2.3.1 darwin-arm64 node-v18.14.2
 $ hackmd-cli --help [COMMAND]
 USAGE
   $ hackmd-cli COMMAND
@@ -97,6 +97,9 @@ All available configurations are listed in the table below.
 ## Commands
 
 <!-- commands -->
+* [`hackmd-cli completion`](#hackmd-cli-completion)
+* [`hackmd-cli completion generate`](#hackmd-cli-completion-generate)
+* [`hackmd-cli completion generate alias ALIAS`](#hackmd-cli-completion-generate-alias-alias)
 * [`hackmd-cli export`](#hackmd-cli-export)
 * [`hackmd-cli help [COMMANDS]`](#hackmd-cli-help-commands)
 * [`hackmd-cli history`](#hackmd-cli-history)
@@ -114,6 +117,73 @@ All available configurations are listed in the table below.
 * [`hackmd-cli version`](#hackmd-cli-version)
 * [`hackmd-cli whoami`](#hackmd-cli-whoami)
 
+## `hackmd-cli completion`
+
+Generate shell completion script
+
+```
+USAGE
+  $ hackmd-cli completion -s bash|fish|zsh
+
+FLAGS
+  -s, --shell=<option>  (required) Name of shell
+                        <options: bash|fish|zsh>
+
+DESCRIPTION
+  Generate shell completion script
+
+  Run this command to see instructions for your shell.
+
+EXAMPLES
+  $ hackmd-cli completion --shell zsh
+```
+
+_See code: [oclif-plugin-completion](https://github.com/MunifTanjim/oclif-plugin-completion/blob/0.6.0/src/commands/completion/index.ts)_
+
+## `hackmd-cli completion generate`
+
+Generates completion script
+
+```
+USAGE
+  $ hackmd-cli completion generate -s bash|fish|zsh
+
+FLAGS
+  -s, --shell=<option>  (required) Name of shell
+                        <options: bash|fish|zsh>
+
+DESCRIPTION
+  Generates completion script
+
+  Run the "completion" command to see instructions about how to use the script generated by this command.
+
+EXAMPLES
+  $ hackmd-cli completion:generate --shell zsh
+```
+
+## `hackmd-cli completion generate alias ALIAS`
+
+Generates completion script for alias
+
+```
+USAGE
+  $ hackmd-cli completion generate alias ALIAS -s bash|fish
+
+ARGUMENTS
+  ALIAS  name of the alias
+
+FLAGS
+  -s, --shell=<option>  (required) Name of shell
+                        <options: bash|fish>
+
+DESCRIPTION
+  Generates completion script for alias
+
+  This needs the completion script for the main command to be present.
+
+  Check the "completion:generate" command.
+```
+
 ## `hackmd-cli export`
 
 Export note content
@@ -134,7 +204,7 @@ EXAMPLES
   # A note to be exported
 ```
 
-_See code: [src/commands/export.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.3.0/src/commands/export.ts)_
+_See code: [src/commands/export.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.3.1/src/commands/export.ts)_
 
 ## `hackmd-cli help [COMMANDS]`
 
@@ -188,7 +258,7 @@ EXAMPLES
   BnC6gN0_TfStV2KKmPPXeg Welcome to your team's workspace null                   CLI-test
 ```
 
-_See code: [src/commands/history.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.3.0/src/commands/history.ts)_
+_See code: [src/commands/history.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.3.1/src/commands/history.ts)_
 
 ## `hackmd-cli login`
 
@@ -210,7 +280,7 @@ EXAMPLES
   Login successfully
 ```
 
-_See code: [src/commands/login.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.3.0/src/commands/login.ts)_
+_See code: [src/commands/login.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.3.1/src/commands/login.ts)_
 
 ## `hackmd-cli logout`
 
@@ -231,7 +301,7 @@ EXAMPLES
   You've logged out successfully
 ```
 
-_See code: [src/commands/logout.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.3.0/src/commands/logout.ts)_
+_See code: [src/commands/logout.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.3.1/src/commands/logout.ts)_
 
 ## `hackmd-cli notes`
 
@@ -265,7 +335,7 @@ EXAMPLES
   raUuSTetT5uQbqQfLnz9lA CLI test note                    gvfz2UB5THiKABQJQnLs6Q null
 ```
 
-_See code: [src/commands/notes/index.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.3.0/src/commands/notes/index.ts)_
+_See code: [src/commands/notes/index.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.3.1/src/commands/notes/index.ts)_
 
 ## `hackmd-cli notes create`
 
@@ -382,7 +452,7 @@ EXAMPLES
   BnC6gN0_TfStV2KKmPPXeg Welcome to your team's workspace null     CLI-test
 ```
 
-_See code: [src/commands/team-notes/index.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.3.0/src/commands/team-notes/index.ts)_
+_See code: [src/commands/team-notes/index.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.3.1/src/commands/team-notes/index.ts)_
 
 ## `hackmd-cli team-notes create`
 
@@ -499,7 +569,7 @@ EXAMPLES
   f76308a6-d77a-41f6-86d0-8ada426a6fb4 CLI test team CLI-test 82f7f3d9-4079-4c78-8a00-14094272ece9
 ```
 
-_See code: [src/commands/teams.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.3.0/src/commands/teams.ts)_
+_See code: [src/commands/teams.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.3.1/src/commands/teams.ts)_
 
 ## `hackmd-cli version`
 
@@ -552,7 +622,7 @@ EXAMPLES
   82f7f3d9-4079-4c78-8a00-14094272ece9 Ming-Hsiu Tsai null  gvfz2UB5THiKABQJQnLs6Q
 ```
 
-_See code: [src/commands/whoami.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.3.0/src/commands/whoami.ts)_
+_See code: [src/commands/whoami.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.3.1/src/commands/whoami.ts)_
 <!-- commandsstop -->
 
 ## License

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hackmd/hackmd-cli",
-  "version": "2.3.0",
+  "version": "2.3.1",
   "author": "HackMD Team",
   "bin": {
     "hackmd-cli": "./bin/run"
@@ -15,6 +15,7 @@
     "fs-extra": "^8.1.0",
     "lodash.defaults": "^4.2.0",
     "oclif": "3.8.1",
+    "oclif-plugin-completion": "^0.6.0",
     "tslib": "^2.5.0"
   },
   "devDependencies": {
@@ -63,7 +64,8 @@
     ],
     "plugins": [
       "@oclif/plugin-help",
-      "@oclif/plugin-version"
+      "@oclif/plugin-version",
+      "oclif-plugin-completion"
     ]
   },
   "repository": "hackmdio/hackmd-cli",

yarn.lock

@@ -496,7 +496,7 @@
     supports-color "^8.1.1"
     tslib "^2"
 
-"@oclif/command@^1.8.15":
+"@oclif/command@^1", "@oclif/command@^1.8.15":
   version "1.8.24"
   resolved "https://registry.yarnpkg.com/@oclif/command/-/command-1.8.24.tgz#203ad9e2b2dc2336c0333f100978aada50d53007"
   integrity sha512-FbSChfBO2QFeC5eEeXmi8+kZvBCDzYdpEKhOMaz0sfKMerwSlKxsqWQPGWCjTHaowIUMtnMD3VZ8yfX5qE7SAQ==
@@ -520,7 +520,7 @@
     is-wsl "^2.1.1"
     tslib "^2.3.1"
 
-"@oclif/config@^1.18.2":
+"@oclif/config@^1", "@oclif/config@^1.18.2":
   version "1.18.8"
   resolved "https://registry.yarnpkg.com/@oclif/config/-/config-1.18.8.tgz#efaccbd0381f90a98fa69c9131e14c5a91fc0659"
   integrity sha512-FetS52+emaZQui0roFSdbBP8ddBkIezEoH2NcjLJRjqkMGdE9Z1V+jsISVqTYXk2KJ1gAI0CHDXFjJlNBYbJBg==
@@ -4074,6 +4074,15 @@ object-treeify@^1.1.33, object-treeify@^1.1.4:
   resolved "https://registry.yarnpkg.com/object-treeify/-/object-treeify-1.1.33.tgz#f06fece986830a3cba78ddd32d4c11d1f76cdf40"
   integrity sha512-EFVjAYfzWqWsBMRHPMAXLCDIJnpMhdWAqR7xG6M6a2cs6PMFpl/+Z20w9zDW4vkxOFfddegBKq9Rehd0bxWE7A==
 
+oclif-plugin-completion@^0.6.0:
+  version "0.6.0"
+  resolved "https://registry.yarnpkg.com/oclif-plugin-completion/-/oclif-plugin-completion-0.6.0.tgz#b9828d33cce01a4577f0d4c8c23a66220705d81f"
+  integrity sha512-0HGaSR/E/seIhSzFxLkh0QqckuNSre4iGqSElZRUv1hVHH2YgrZ7xtQL9McwL8o1fh6HqkzykjUx0Iy2haVIUg==
+  dependencies:
+    "@oclif/command" "^1"
+    "@oclif/config" "^1"
+    tslib "^2"
+
 oclif@3.8.1:
   version "3.8.1"
   resolved "https://registry.yarnpkg.com/oclif/-/oclif-3.8.1.tgz#15be26a8ce842b690c8384b4056fcf67394caa11"