Skip to content

Commit 981e5ff

Browse files
committed
chore: bump version to 2.3.2
1 parent 6e798b7 commit 981e5ff

File tree

2 files changed

+25
-63
lines changed

2 files changed

+25
-63
lines changed

README.md

+24-62
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ $ npm install -g @hackmd/hackmd-cli
2828
$ hackmd-cli COMMAND
2929
running command...
3030
$ hackmd-cli (--version|-v)
31-
@hackmd/hackmd-cli/2.3.1 darwin-arm64 node-v18.14.2
31+
@hackmd/hackmd-cli/2.3.2 darwin-arm64 node-v18.14.2
3232
$ hackmd-cli --help [COMMAND]
3333
USAGE
3434
$ hackmd-cli COMMAND
@@ -97,9 +97,7 @@ All available configurations are listed in the table below.
9797
## Commands
9898

9999
<!-- commands -->
100-
* [`hackmd-cli completion`](#hackmd-cli-completion)
101-
* [`hackmd-cli completion generate`](#hackmd-cli-completion-generate)
102-
* [`hackmd-cli completion generate alias ALIAS`](#hackmd-cli-completion-generate-alias-alias)
100+
* [`hackmd-cli autocomplete [SHELL]`](#hackmd-cli-autocomplete-shell)
103101
* [`hackmd-cli export`](#hackmd-cli-export)
104102
* [`hackmd-cli help [COMMANDS]`](#hackmd-cli-help-commands)
105103
* [`hackmd-cli history`](#hackmd-cli-history)
@@ -117,73 +115,37 @@ All available configurations are listed in the table below.
117115
* [`hackmd-cli version`](#hackmd-cli-version)
118116
* [`hackmd-cli whoami`](#hackmd-cli-whoami)
119117

120-
## `hackmd-cli completion`
118+
## `hackmd-cli autocomplete [SHELL]`
121119

122-
Generate shell completion script
120+
display autocomplete installation instructions
123121

124122
```
125123
USAGE
126-
$ hackmd-cli completion -s bash|fish|zsh
124+
$ hackmd-cli autocomplete [SHELL] [-r]
127125
128-
FLAGS
129-
-s, --shell=<option> (required) Name of shell
130-
<options: bash|fish|zsh>
131-
132-
DESCRIPTION
133-
Generate shell completion script
134-
135-
Run this command to see instructions for your shell.
136-
137-
EXAMPLES
138-
$ hackmd-cli completion --shell zsh
139-
```
140-
141-
_See code: [oclif-plugin-completion](https://github.com/MunifTanjim/oclif-plugin-completion/blob/0.6.0/src/commands/completion/index.ts)_
142-
143-
## `hackmd-cli completion generate`
144-
145-
Generates completion script
146-
147-
```
148-
USAGE
149-
$ hackmd-cli completion generate -s bash|fish|zsh
126+
ARGUMENTS
127+
SHELL shell type
150128
151129
FLAGS
152-
-s, --shell=<option> (required) Name of shell
153-
<options: bash|fish|zsh>
130+
-r, --refresh-cache Refresh cache (ignores displaying instructions)
154131
155132
DESCRIPTION
156-
Generates completion script
157-
158-
Run the "completion" command to see instructions about how to use the script generated by this command.
133+
display autocomplete installation instructions
159134
160135
EXAMPLES
161-
$ hackmd-cli completion:generate --shell zsh
162-
```
136+
$ hackmd-cli autocomplete
163137
164-
## `hackmd-cli completion generate alias ALIAS`
138+
$ hackmd-cli autocomplete bash
165139
166-
Generates completion script for alias
140+
$ hackmd-cli autocomplete fish
167141
168-
```
169-
USAGE
170-
$ hackmd-cli completion generate alias ALIAS -s bash|fish
171-
172-
ARGUMENTS
173-
ALIAS name of the alias
142+
$ hackmd-cli autocomplete zsh
174143
175-
FLAGS
176-
-s, --shell=<option> (required) Name of shell
177-
<options: bash|fish>
178-
179-
DESCRIPTION
180-
Generates completion script for alias
181-
182-
This needs the completion script for the main command to be present.
183-
184-
Check the "completion:generate" command.
144+
$ hackmd-cli autocomplete --refresh-cache
185145
```
186146

147+
_See code: [@hackmd/oclif-plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v2.1.9-fish/src/commands/autocomplete/index.ts)_
148+
187149
## `hackmd-cli export`
188150

189151
Export note content
@@ -204,7 +166,7 @@ EXAMPLES
204166
# A note to be exported
205167
```
206168

207-
_See code: [src/commands/export.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.3.1/src/commands/export.ts)_
169+
_See code: [src/commands/export.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.3.2/src/commands/export.ts)_
208170

209171
## `hackmd-cli help [COMMANDS]`
210172

@@ -258,7 +220,7 @@ EXAMPLES
258220
BnC6gN0_TfStV2KKmPPXeg Welcome to your team's workspace null CLI-test
259221
```
260222

261-
_See code: [src/commands/history.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.3.1/src/commands/history.ts)_
223+
_See code: [src/commands/history.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.3.2/src/commands/history.ts)_
262224

263225
## `hackmd-cli login`
264226

@@ -280,7 +242,7 @@ EXAMPLES
280242
Login successfully
281243
```
282244

283-
_See code: [src/commands/login.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.3.1/src/commands/login.ts)_
245+
_See code: [src/commands/login.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.3.2/src/commands/login.ts)_
284246

285247
## `hackmd-cli logout`
286248

@@ -301,7 +263,7 @@ EXAMPLES
301263
You've logged out successfully
302264
```
303265

304-
_See code: [src/commands/logout.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.3.1/src/commands/logout.ts)_
266+
_See code: [src/commands/logout.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.3.2/src/commands/logout.ts)_
305267

306268
## `hackmd-cli notes`
307269

@@ -335,7 +297,7 @@ EXAMPLES
335297
raUuSTetT5uQbqQfLnz9lA CLI test note gvfz2UB5THiKABQJQnLs6Q null
336298
```
337299

338-
_See code: [src/commands/notes/index.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.3.1/src/commands/notes/index.ts)_
300+
_See code: [src/commands/notes/index.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.3.2/src/commands/notes/index.ts)_
339301

340302
## `hackmd-cli notes create`
341303

@@ -452,7 +414,7 @@ EXAMPLES
452414
BnC6gN0_TfStV2KKmPPXeg Welcome to your team's workspace null CLI-test
453415
```
454416

455-
_See code: [src/commands/team-notes/index.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.3.1/src/commands/team-notes/index.ts)_
417+
_See code: [src/commands/team-notes/index.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.3.2/src/commands/team-notes/index.ts)_
456418

457419
## `hackmd-cli team-notes create`
458420

@@ -569,7 +531,7 @@ EXAMPLES
569531
f76308a6-d77a-41f6-86d0-8ada426a6fb4 CLI test team CLI-test 82f7f3d9-4079-4c78-8a00-14094272ece9
570532
```
571533

572-
_See code: [src/commands/teams.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.3.1/src/commands/teams.ts)_
534+
_See code: [src/commands/teams.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.3.2/src/commands/teams.ts)_
573535

574536
## `hackmd-cli version`
575537

@@ -622,7 +584,7 @@ EXAMPLES
622584
82f7f3d9-4079-4c78-8a00-14094272ece9 Ming-Hsiu Tsai null gvfz2UB5THiKABQJQnLs6Q
623585
```
624586

625-
_See code: [src/commands/whoami.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.3.1/src/commands/whoami.ts)_
587+
_See code: [src/commands/whoami.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.3.2/src/commands/whoami.ts)_
626588
<!-- commandsstop -->
627589

628590
## License

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@hackmd/hackmd-cli",
3-
"version": "2.3.1",
3+
"version": "2.3.2",
44
"author": "HackMD Team",
55
"bin": {
66
"hackmd-cli": "./bin/run"

0 commit comments

Comments
 (0)