1
- hackmd-cli - The HackMD/CodiMD Command Line Tool
2
- ===
1
+ # hackmd-cli - The HackMD/CodiMD Command Line Tool
3
2
4
3
[ ![ oclif] ( https://img.shields.io/badge/cli-oclif-brightgreen.svg )] ( https://oclif.io )
5
4
[ ![ Version] ( https://img.shields.io/npm/v/@hackmd/hackmd-cli.svg )] ( https://npmjs.org/package/@hackmd/hackmd-cli )
@@ -18,7 +17,7 @@ $ npm install -g @hackmd/hackmd-cli
18
17
$ hackmd-cli COMMAND
19
18
running command...
20
19
$ hackmd-cli (-v| --version| version)
21
- @hackmd/hackmd-cli/1.1.1 darwin-x64 node-v12.16.2
20
+ @hackmd/hackmd-cli/1.2.0 darwin-x64 node-v12.21.0
22
21
$ hackmd-cli --help [COMMAND]
23
22
USAGE
24
23
$ hackmd-cli COMMAND
@@ -59,7 +58,7 @@ Or in JSON file (`~/.hackmd/config.json`):
59
58
60
59
``` json
61
60
{
62
- "serverUrl" : " https://https:// my.hackmd-ee.domain"
61
+ "serverUrl" : " https://my.hackmd-ee.domain"
63
62
}
64
63
```
65
64
@@ -84,6 +83,7 @@ _Don't commit your login credentials!_
84
83
* [ ` hackmd-cli help [COMMAND] ` ] ( #hackmd-cli-help-command )
85
84
* [ ` hackmd-cli history ` ] ( #hackmd-cli-history )
86
85
* [ ` hackmd-cli import [FILE] ` ] ( #hackmd-cli-import-file )
86
+ * [ ` hackmd-cli list ` ] ( #hackmd-cli-list )
87
87
* [ ` hackmd-cli login ` ] ( #hackmd-cli-login )
88
88
* [ ` hackmd-cli logout ` ] ( #hackmd-cli-logout )
89
89
* [ ` hackmd-cli teams ` ] ( #hackmd-cli-teams )
@@ -107,7 +107,7 @@ EXAMPLE
107
107
$ hackmd-cli export [--pdf|--md|--html] <note_id> <output_file>
108
108
```
109
109
110
- _ See code: [ src/commands/export.ts] ( https://github.com/hackmdio/hackmd-cli/blob/v1.1.1 /src/commands/export.ts ) _
110
+ _ See code: [ src/commands/export.ts] ( https://github.com/hackmdio/hackmd-cli/blob/v1.2.0 /src/commands/export.ts ) _
111
111
112
112
## ` hackmd-cli help [COMMAND] `
113
113
@@ -153,7 +153,7 @@ EXAMPLE
153
153
EeNHDGocSTi70ytMMGQaaQ Note2
154
154
```
155
155
156
- _ See code: [ src/commands/history.ts] ( https://github.com/hackmdio/hackmd-cli/blob/v1.1.1 /src/commands/history.ts ) _
156
+ _ See code: [ src/commands/history.ts] ( https://github.com/hackmdio/hackmd-cli/blob/v1.2.0 /src/commands/history.ts ) _
157
157
158
158
## ` hackmd-cli import [FILE] `
159
159
@@ -173,7 +173,37 @@ EXAMPLE
173
173
Your note is available at https://hackmd.io/note-url
174
174
```
175
175
176
- _ See code: [ src/commands/import.ts] ( https://github.com/hackmdio/hackmd-cli/blob/v1.1.1/src/commands/import.ts ) _
176
+ _ See code: [ src/commands/import.ts] ( https://github.com/hackmdio/hackmd-cli/blob/v1.2.0/src/commands/import.ts ) _
177
+
178
+ ## ` hackmd-cli list `
179
+
180
+ List owned notes or team notes (HackMD-only feature)
181
+
182
+ ```
183
+ USAGE
184
+ $ hackmd-cli list
185
+
186
+ OPTIONS
187
+ -h, --help show CLI help
188
+ -t, --team=team team name
189
+ -x, --extended show extra columns
190
+ --columns=columns only show provided columns (comma-separated)
191
+ --csv output is csv format [alias: --output=csv]
192
+ --filter=filter filter property by partial string matching, ex: name=foo
193
+ --no-header hide table header from output
194
+ --no-truncate do not truncate output to fit screen
195
+ --output=csv|json|yaml output in a more machine friendly format
196
+ --sort=sort property to sort by (prepend '-' for descending)
197
+
198
+ EXAMPLE
199
+ $ hackmd-cli list
200
+
201
+ ID Name
202
+ A58r8ehYTlySO94oiC_MUA Note1
203
+ EeNHDGocSTi70ytMMGQaaQ Note2
204
+ ```
205
+
206
+ _ See code: [ src/commands/list.ts] ( https://github.com/hackmdio/hackmd-cli/blob/v1.2.0/src/commands/list.ts ) _
177
207
178
208
## ` hackmd-cli login `
179
209
@@ -197,7 +227,7 @@ EXAMPLE
197
227
Login as HMD successfully!
198
228
```
199
229
200
- _ See code: [ src/commands/login.ts] ( https://github.com/hackmdio/hackmd-cli/blob/v1.1.1 /src/commands/login.ts ) _
230
+ _ See code: [ src/commands/login.ts] ( https://github.com/hackmdio/hackmd-cli/blob/v1.2.0 /src/commands/login.ts ) _
201
231
202
232
## ` hackmd-cli logout `
203
233
@@ -216,7 +246,7 @@ EXAMPLE
216
246
You've logged out successfully
217
247
```
218
248
219
- _ See code: [ src/commands/logout.ts] ( https://github.com/hackmdio/hackmd-cli/blob/v1.1.1 /src/commands/logout.ts ) _
249
+ _ See code: [ src/commands/logout.ts] ( https://github.com/hackmdio/hackmd-cli/blob/v1.2.0 /src/commands/logout.ts ) _
220
250
221
251
## ` hackmd-cli teams `
222
252
@@ -245,7 +275,7 @@ EXAMPLE
245
275
my-awesome-team My Awesome Team
246
276
```
247
277
248
- _ See code: [ src/commands/teams.ts] ( https://github.com/hackmdio/hackmd-cli/blob/v1.1.1 /src/commands/teams.ts ) _
278
+ _ See code: [ src/commands/teams.ts] ( https://github.com/hackmdio/hackmd-cli/blob/v1.2.0 /src/commands/teams.ts ) _
249
279
250
280
## ` hackmd-cli whoami `
251
281
@@ -264,7 +294,7 @@ EXAMPLE
264
294
You are logged in hackmd.io as {YOUR NAME} [user-id]
265
295
```
266
296
267
- _ See code: [ src/commands/whoami.ts] ( https://github.com/hackmdio/hackmd-cli/blob/v1.1.1 /src/commands/whoami.ts ) _
297
+ _ See code: [ src/commands/whoami.ts] ( https://github.com/hackmdio/hackmd-cli/blob/v1.2.0 /src/commands/whoami.ts ) _
268
298
<!-- commandsstop -->
269
299
270
300
## ` hackmd-cli ` piping mode
0 commit comments