Skip to content

Commit 571787f

Browse files
committed
Update README
1 parent 5d67770 commit 571787f

File tree

1 file changed

+43
-12
lines changed

1 file changed

+43
-12
lines changed

README.md

+43-12
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ $ npm install -g @hackmd/hackmd-cli
1818
$ hackmd-cli COMMAND
1919
running command...
2020
$ hackmd-cli (-v|--version|version)
21-
@hackmd/hackmd-cli/1.1.0 linux-x64 node-v12.16.2
21+
@hackmd/hackmd-cli/1.1.1 darwin-x64 node-v12.16.2
2222
$ hackmd-cli --help [COMMAND]
2323
USAGE
2424
$ hackmd-cli COMMAND
@@ -86,6 +86,7 @@ _Don't commit your login credentials!_
8686
* [`hackmd-cli import [FILE]`](#hackmd-cli-import-file)
8787
* [`hackmd-cli login`](#hackmd-cli-login)
8888
* [`hackmd-cli logout`](#hackmd-cli-logout)
89+
* [`hackmd-cli teams`](#hackmd-cli-teams)
8990
* [`hackmd-cli whoami`](#hackmd-cli-whoami)
9091

9192
## `hackmd-cli export [NOTEID] [OUTPUT]`
@@ -106,7 +107,7 @@ EXAMPLE
106107
$ hackmd-cli export [--pdf|--md|--html] <note_id> <output_file>
107108
```
108109

109-
_See code: [src/commands/export.ts](https://github.com/hackmdio/hackmd-cli/blob/v1.1.0/src/commands/export.ts)_
110+
_See code: [src/commands/export.ts](https://github.com/hackmdio/hackmd-cli/blob/v1.1.1/src/commands/export.ts)_
110111

111112
## `hackmd-cli help [COMMAND]`
112113

@@ -152,7 +153,7 @@ EXAMPLE
152153
EeNHDGocSTi70ytMMGQaaQ Note2
153154
```
154155

155-
_See code: [src/commands/history.ts](https://github.com/hackmdio/hackmd-cli/blob/v1.1.0/src/commands/history.ts)_
156+
_See code: [src/commands/history.ts](https://github.com/hackmdio/hackmd-cli/blob/v1.1.1/src/commands/history.ts)_
156157

157158
## `hackmd-cli import [FILE]`
158159

@@ -163,19 +164,20 @@ USAGE
163164
$ hackmd-cli import [FILE]
164165
165166
OPTIONS
166-
-h, --help show CLI help
167+
-h, --help show CLI help
168+
-t, --team=team team to use
167169
168170
EXAMPLE
169-
$ hackmd-cli import /path/to/markdown/file.md
171+
$ hackmd-cli import /path/to/markdown/file.md --team=xxx
170172
171-
Your note is available at https://codimd.domain/note-url
173+
Your note is available at https://hackmd.io/note-url
172174
```
173175

174-
_See code: [src/commands/import.ts](https://github.com/hackmdio/hackmd-cli/blob/v1.1.0/src/commands/import.ts)_
176+
_See code: [src/commands/import.ts](https://github.com/hackmdio/hackmd-cli/blob/v1.1.1/src/commands/import.ts)_
175177

176178
## `hackmd-cli login`
177179

178-
Login HackMD instance from CLI
180+
Login to HackMD/CodiMD server from CLI
179181

180182
```
181183
USAGE
@@ -189,13 +191,13 @@ OPTIONS
189191
EXAMPLE
190192
$ hackmd-cli login
191193
192-
Enter your email: hello@codimd.domain
194+
Enter your email: hello@hackmd.io
193195
Enter your password: *******
194196
195197
Login as HMD successfully!
196198
```
197199

198-
_See code: [src/commands/login.ts](https://github.com/hackmdio/hackmd-cli/blob/v1.1.0/src/commands/login.ts)_
200+
_See code: [src/commands/login.ts](https://github.com/hackmdio/hackmd-cli/blob/v1.1.1/src/commands/login.ts)_
199201

200202
## `hackmd-cli logout`
201203

@@ -214,7 +216,36 @@ EXAMPLE
214216
You've logged out successfully
215217
```
216218

217-
_See code: [src/commands/logout.ts](https://github.com/hackmdio/hackmd-cli/blob/v1.1.0/src/commands/logout.ts)_
219+
_See code: [src/commands/logout.ts](https://github.com/hackmdio/hackmd-cli/blob/v1.1.1/src/commands/logout.ts)_
220+
221+
## `hackmd-cli teams`
222+
223+
HackMD Teams Command
224+
225+
```
226+
USAGE
227+
$ hackmd-cli teams
228+
229+
OPTIONS
230+
-h, --help show CLI help
231+
-x, --extended show extra columns
232+
--columns=columns only show provided columns (comma-separated)
233+
--csv output is csv format [alias: --output=csv]
234+
--filter=filter filter property by partial string matching, ex: name=foo
235+
--no-header hide table header from output
236+
--no-truncate do not truncate output to fit screen
237+
--output=csv|json|yaml output in a more machine friendly format
238+
--sort=sort property to sort by (prepend '-' for descending)
239+
240+
EXAMPLE
241+
$ hackmd-cli teams
242+
243+
Path Name
244+
team1 Team 1
245+
my-awesome-team My Awesome Team
246+
```
247+
248+
_See code: [src/commands/teams.ts](https://github.com/hackmdio/hackmd-cli/blob/v1.1.1/src/commands/teams.ts)_
218249

219250
## `hackmd-cli whoami`
220251

@@ -233,7 +264,7 @@ EXAMPLE
233264
You are logged in hackmd.io as {YOUR NAME} [user-id]
234265
```
235266

236-
_See code: [src/commands/whoami.ts](https://github.com/hackmdio/hackmd-cli/blob/v1.1.0/src/commands/whoami.ts)_
267+
_See code: [src/commands/whoami.ts](https://github.com/hackmdio/hackmd-cli/blob/v1.1.1/src/commands/whoami.ts)_
237268
<!-- commandsstop -->
238269

239270
## `hackmd-cli` piping mode

0 commit comments

Comments
 (0)