1- hackmd-cli - The HackMD/CodiMD Command Line Tool
2- ===
1+ # hackmd-cli - The HackMD/CodiMD Command Line Tool
32
43[ ![ oclif] ( https://img.shields.io/badge/cli-oclif-brightgreen.svg )] ( https://oclif.io )
54[ ![ 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
1817$ hackmd-cli COMMAND
1918running command...
2019$ 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
2221$ hackmd-cli --help [COMMAND]
2322USAGE
2423 $ hackmd-cli COMMAND
@@ -59,7 +58,7 @@ Or in JSON file (`~/.hackmd/config.json`):
5958
6059``` json
6160{
62- "serverUrl" : " https://https:// my.hackmd-ee.domain"
61+ "serverUrl" : " https://my.hackmd-ee.domain"
6362}
6463```
6564
@@ -84,6 +83,7 @@ _Don't commit your login credentials!_
8483* [ ` hackmd-cli help [COMMAND] ` ] ( #hackmd-cli-help-command )
8584* [ ` hackmd-cli history ` ] ( #hackmd-cli-history )
8685* [ ` hackmd-cli import [FILE] ` ] ( #hackmd-cli-import-file )
86+ * [ ` hackmd-cli list ` ] ( #hackmd-cli-list )
8787* [ ` hackmd-cli login ` ] ( #hackmd-cli-login )
8888* [ ` hackmd-cli logout ` ] ( #hackmd-cli-logout )
8989* [ ` hackmd-cli teams ` ] ( #hackmd-cli-teams )
@@ -107,7 +107,7 @@ EXAMPLE
107107 $ hackmd-cli export [--pdf|--md|--html] <note_id> <output_file>
108108```
109109
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 ) _
111111
112112## ` hackmd-cli help [COMMAND] `
113113
@@ -153,7 +153,7 @@ EXAMPLE
153153 EeNHDGocSTi70ytMMGQaaQ Note2
154154```
155155
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 ) _
157157
158158## ` hackmd-cli import [FILE] `
159159
@@ -173,7 +173,37 @@ EXAMPLE
173173 Your note is available at https://hackmd.io/note-url
174174```
175175
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 ) _
177207
178208## ` hackmd-cli login `
179209
@@ -197,7 +227,7 @@ EXAMPLE
197227 Login as HMD successfully!
198228```
199229
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 ) _
201231
202232## ` hackmd-cli logout `
203233
@@ -216,7 +246,7 @@ EXAMPLE
216246 You've logged out successfully
217247```
218248
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 ) _
220250
221251## ` hackmd-cli teams `
222252
@@ -245,7 +275,7 @@ EXAMPLE
245275 my-awesome-team My Awesome Team
246276```
247277
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 ) _
249279
250280## ` hackmd-cli whoami `
251281
@@ -264,7 +294,7 @@ EXAMPLE
264294 You are logged in hackmd.io as {YOUR NAME} [user-id]
265295```
266296
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 ) _
268298<!-- commandsstop -->
269299
270300## ` hackmd-cli ` piping mode
0 commit comments