Skip to content

Commit

Permalink
Merge pull request #59 from hackmdio/develop
Browse files Browse the repository at this point in the history
v2.0.1
  • Loading branch information
Yukaii authored Mar 10, 2022
2 parents d0eec90 + bf3d8f0 commit 72b1795
Showing 11 changed files with 131 additions and 252 deletions.
2 changes: 1 addition & 1 deletion .nvmrc
Original file line number Diff line number Diff line change
@@ -1 +1 @@
12
17
50 changes: 35 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -28,7 +28,7 @@ $ npm install -g @hackmd/hackmd-cli
$ hackmd-cli COMMAND
running command...
$ hackmd-cli (-v|--version|version)
@hackmd/hackmd-cli/2.0.0 darwin-x64 node-v12.21.0
@hackmd/hackmd-cli/2.0.1 darwin-arm64 node-v17.7.0
$ hackmd-cli --help [COMMAND]
USAGE
$ hackmd-cli COMMAND
@@ -97,6 +97,7 @@ All available configurations are listed in the table below.
## Commands

<!-- commands -->
* [`hackmd-cli export`](#hackmd-cli-export)
* [`hackmd-cli help [COMMAND]`](#hackmd-cli-help-command)
* [`hackmd-cli history`](#hackmd-cli-history)
* [`hackmd-cli login`](#hackmd-cli-login)
@@ -113,6 +114,25 @@ All available configurations are listed in the table below.
* [`hackmd-cli version`](#hackmd-cli-version)
* [`hackmd-cli whoami`](#hackmd-cli-whoami)

## `hackmd-cli export`

Export note content

```
USAGE
$ hackmd-cli export
OPTIONS
-h, --help Show CLI help.
--noteId=noteId HackMD note id
EXAMPLE
$ hackmd-cli export --noteId=kNFWV5E-Qz-QP7u6XnNvyQ
# A note to be exported
```

_See code: [src/commands/export.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.0.1/src/commands/export.ts)_

## `hackmd-cli help [COMMAND]`

display help for hackmd-cli
@@ -157,7 +177,7 @@ EXAMPLE
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.0.0/src/commands/history.ts)_
_See code: [src/commands/history.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.0.1/src/commands/history.ts)_

## `hackmd-cli login`

@@ -178,7 +198,7 @@ EXAMPLE
Login successfully
```

_See code: [src/commands/login.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.0.0/src/commands/login.ts)_
_See code: [src/commands/login.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.0.1/src/commands/login.ts)_

## `hackmd-cli logout`

@@ -197,7 +217,7 @@ EXAMPLE
You've logged out successfully
```

_See code: [src/commands/logout.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.0.0/src/commands/logout.ts)_
_See code: [src/commands/logout.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.0.1/src/commands/logout.ts)_

## `hackmd-cli notes`

@@ -226,7 +246,7 @@ EXAMPLE
raUuSTetT5uQbqQfLnz9lA CLI test note gvfz2UB5THiKABQJQnLs6Q null
```

_See code: [src/commands/notes/index.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.0.0/src/commands/notes/index.ts)_
_See code: [src/commands/notes/index.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.0.1/src/commands/notes/index.ts)_

## `hackmd-cli notes:create`

@@ -261,7 +281,7 @@ EXAMPLES
cat README.md | hackmd-cli notes create
```

_See code: [src/commands/notes/create.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.0.0/src/commands/notes/create.ts)_
_See code: [src/commands/notes/create.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.0.1/src/commands/notes/create.ts)_

## `hackmd-cli notes:delete`

@@ -279,7 +299,7 @@ EXAMPLE
$ hackmd-cli notes delete --noteId=WNkLM6gkS0Cg2cQ8rv7bYA
```

_See code: [src/commands/notes/delete.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.0.0/src/commands/notes/delete.ts)_
_See code: [src/commands/notes/delete.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.0.1/src/commands/notes/delete.ts)_

## `hackmd-cli notes:update`

@@ -295,10 +315,10 @@ OPTIONS
--noteId=noteId HackMD note id
EXAMPLE
$ hackmd-cli notes update --teamPath=CLI-test --noteId=WNkLM6gkS0Cg2cQ8rv7bYA --content='# A new title'
$ hackmd-cli notes update --noteId=WNkLM6gkS0Cg2cQ8rv7bYA --content='# A new title'
```

_See code: [src/commands/notes/update.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.0.0/src/commands/notes/update.ts)_
_See code: [src/commands/notes/update.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.0.1/src/commands/notes/update.ts)_

## `hackmd-cli team-notes`

@@ -328,7 +348,7 @@ EXAMPLE
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.0.0/src/commands/team-notes/index.ts)_
_See code: [src/commands/team-notes/index.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.0.1/src/commands/team-notes/index.ts)_

## `hackmd-cli team-notes:create`

@@ -365,7 +385,7 @@ EXAMPLES
cat README.md | hackmd-cli notes create --teamPath=CLI-test
```

_See code: [src/commands/team-notes/create.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.0.0/src/commands/team-notes/create.ts)_
_See code: [src/commands/team-notes/create.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.0.1/src/commands/team-notes/create.ts)_

## `hackmd-cli team-notes:delete`

@@ -384,7 +404,7 @@ EXAMPLE
$ hackmd-cli team-notes delete --teamPath=CLI-test --noteId=WNkLM6gkS0Cg2cQ8rv7bYA
```

_See code: [src/commands/team-notes/delete.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.0.0/src/commands/team-notes/delete.ts)_
_See code: [src/commands/team-notes/delete.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.0.1/src/commands/team-notes/delete.ts)_

## `hackmd-cli team-notes:update`

@@ -404,7 +424,7 @@ EXAMPLE
$ hackmd-cli team-notes update --teamPath=CLI-test --noteId=WNkLM6gkS0Cg2cQ8rv7bYA --content='# A new title'
```

_See code: [src/commands/team-notes/update.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.0.0/src/commands/team-notes/update.ts)_
_See code: [src/commands/team-notes/update.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.0.1/src/commands/team-notes/update.ts)_

## `hackmd-cli teams`

@@ -432,7 +452,7 @@ EXAMPLE
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.0.0/src/commands/teams.ts)_
_See code: [src/commands/teams.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.0.1/src/commands/teams.ts)_

## `hackmd-cli version`

@@ -469,7 +489,7 @@ EXAMPLE
82f7f3d9-4079-4c78-8a00-14094272ece9 Ming-Hsiu Tsai null gvfz2UB5THiKABQJQnLs6Q
```

_See code: [src/commands/whoami.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.0.0/src/commands/whoami.ts)_
_See code: [src/commands/whoami.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.0.1/src/commands/whoami.ts)_
<!-- commandsstop -->

## License
Loading

0 comments on commit 72b1795

Please sign in to comment.