|
| 1 | +codimd-cli |
| 2 | +========== |
| 3 | + |
| 4 | +[](https://oclif.io) |
| 5 | +[](https://npmjs.org/package/@hackmd/codimd-cli) |
| 6 | +[](https://npmjs.org/package/@hackmd/codimd-cli) |
| 7 | +[](https://github.com/hackmdio/codimd-cli/blob/master/package.json) |
| 8 | + |
| 9 | +<!-- toc --> |
| 10 | +* [Usage](#usage) |
| 11 | +* [Commands](#commands) |
| 12 | +<!-- tocstop --> |
| 13 | +# Usage |
| 14 | +<!-- usage --> |
| 15 | +```sh-session |
| 16 | +$ npm install -g @hackmd/codimd-cli |
| 17 | +$ codimd-cli COMMAND |
| 18 | +running command... |
| 19 | +$ codimd-cli (-v|--version|version) |
| 20 | +@hackmd/codimd-cli/1.0.0 linux-x64 node-v8.17.0 |
| 21 | +$ codimd-cli --help [COMMAND] |
| 22 | +USAGE |
| 23 | + $ codimd-cli COMMAND |
| 24 | +... |
| 25 | +``` |
| 26 | +<!-- usagestop --> |
| 27 | +# Commands |
| 28 | +<!-- commands --> |
| 29 | +* [`codimd-cli export [NOTEID] [OUTPUT]`](#codimd-cli-export-noteid-output) |
| 30 | +* [`codimd-cli help [COMMAND]`](#codimd-cli-help-command) |
| 31 | +* [`codimd-cli history`](#codimd-cli-history) |
| 32 | +* [`codimd-cli import [FILE]`](#codimd-cli-import-file) |
| 33 | +* [`codimd-cli login`](#codimd-cli-login) |
| 34 | +* [`codimd-cli logout`](#codimd-cli-logout) |
| 35 | +* [`codimd-cli whoami`](#codimd-cli-whoami) |
| 36 | + |
| 37 | +## `codimd-cli export [NOTEID] [OUTPUT]` |
| 38 | + |
| 39 | +Export note to local file |
| 40 | + |
| 41 | +``` |
| 42 | +USAGE |
| 43 | + $ codimd-cli export [NOTEID] [OUTPUT] |
| 44 | +
|
| 45 | +OPTIONS |
| 46 | + -h, --help show CLI help |
| 47 | + --html |
| 48 | + --md |
| 49 | + --pdf |
| 50 | +
|
| 51 | +EXAMPLE |
| 52 | + $ codimd-cli export [--pdf|--md|--html] <note_id> <output_file> |
| 53 | +``` |
| 54 | + |
| 55 | +_See code: [src/commands/export.ts](https://github.com/hackmdio/codimd-cli/blob/v1.0.0/src/commands/export.ts)_ |
| 56 | + |
| 57 | +## `codimd-cli help [COMMAND]` |
| 58 | + |
| 59 | +display help for codimd-cli |
| 60 | + |
| 61 | +``` |
| 62 | +USAGE |
| 63 | + $ codimd-cli help [COMMAND] |
| 64 | +
|
| 65 | +ARGUMENTS |
| 66 | + COMMAND command to show help for |
| 67 | +
|
| 68 | +OPTIONS |
| 69 | + --all see all commands in CLI |
| 70 | +``` |
| 71 | + |
| 72 | +_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v2.2.3/src/commands/help.ts)_ |
| 73 | + |
| 74 | +## `codimd-cli history` |
| 75 | + |
| 76 | +List history |
| 77 | + |
| 78 | +``` |
| 79 | +USAGE |
| 80 | + $ codimd-cli history |
| 81 | +
|
| 82 | +OPTIONS |
| 83 | + -h, --help show CLI help |
| 84 | + -x, --extended show extra columns |
| 85 | + --columns=columns only show provided columns (comma-separated) |
| 86 | + --csv output is csv format [alias: --output=csv] |
| 87 | + --filter=filter filter property by partial string matching, ex: name=foo |
| 88 | + --no-header hide table header from output |
| 89 | + --no-truncate do not truncate output to fit screen |
| 90 | + --output=csv|json|yaml output in a more machine friendly format |
| 91 | + --sort=sort property to sort by (prepend '-' for descending) |
| 92 | +
|
| 93 | +EXAMPLE |
| 94 | + $ codimd-cli history |
| 95 | +
|
| 96 | + ID Name |
| 97 | + A58r8ehYTlySO94oiC_MUA Note1 |
| 98 | + EeNHDGocSTi70ytMMGQaaQ Note2 |
| 99 | +``` |
| 100 | + |
| 101 | +_See code: [src/commands/history.ts](https://github.com/hackmdio/codimd-cli/blob/v1.0.0/src/commands/history.ts)_ |
| 102 | + |
| 103 | +## `codimd-cli import [FILE]` |
| 104 | + |
| 105 | +Create a note from markdown file |
| 106 | + |
| 107 | +``` |
| 108 | +USAGE |
| 109 | + $ codimd-cli import [FILE] |
| 110 | +
|
| 111 | +OPTIONS |
| 112 | + -h, --help show CLI help |
| 113 | +
|
| 114 | +EXAMPLE |
| 115 | + $ codimd-cli import /path/to/markdown/file.md |
| 116 | +
|
| 117 | + Your note is available at https://codimd.domain/note-url |
| 118 | +``` |
| 119 | + |
| 120 | +_See code: [src/commands/import.ts](https://github.com/hackmdio/codimd-cli/blob/v1.0.0/src/commands/import.ts)_ |
| 121 | + |
| 122 | +## `codimd-cli login` |
| 123 | + |
| 124 | +Login HackMD instance from CLI |
| 125 | + |
| 126 | +``` |
| 127 | +USAGE |
| 128 | + $ codimd-cli login |
| 129 | +
|
| 130 | +OPTIONS |
| 131 | + -h, --help show CLI help |
| 132 | + -u, --email=email Login email |
| 133 | +
|
| 134 | +EXAMPLE |
| 135 | + $ codimd-cli login |
| 136 | +
|
| 137 | + Enter your email: hello@codimd.domain |
| 138 | + Enter your password: ******* |
| 139 | +
|
| 140 | + Login as HMD successfully! |
| 141 | +``` |
| 142 | + |
| 143 | +_See code: [src/commands/login.ts](https://github.com/hackmdio/codimd-cli/blob/v1.0.0/src/commands/login.ts)_ |
| 144 | + |
| 145 | +## `codimd-cli logout` |
| 146 | + |
| 147 | +Logout from CLI |
| 148 | + |
| 149 | +``` |
| 150 | +USAGE |
| 151 | + $ codimd-cli logout |
| 152 | +
|
| 153 | +OPTIONS |
| 154 | + -h, --help show CLI help |
| 155 | +
|
| 156 | +EXAMPLE |
| 157 | + $ codimd-cli logout |
| 158 | +
|
| 159 | + You've logged out successfully |
| 160 | +``` |
| 161 | + |
| 162 | +_See code: [src/commands/logout.ts](https://github.com/hackmdio/codimd-cli/blob/v1.0.0/src/commands/logout.ts)_ |
| 163 | + |
| 164 | +## `codimd-cli whoami` |
| 165 | + |
| 166 | +Show logged in account info |
| 167 | + |
| 168 | +``` |
| 169 | +USAGE |
| 170 | + $ codimd-cli whoami |
| 171 | +
|
| 172 | +OPTIONS |
| 173 | + -h, --help show CLI help |
| 174 | +
|
| 175 | +EXAMPLE |
| 176 | + $ codimd-cli whoami |
| 177 | +
|
| 178 | + You are logged in codimd.domain as {YOUR NAME} [user-id] |
| 179 | +``` |
| 180 | + |
| 181 | +_See code: [src/commands/whoami.ts](https://github.com/hackmdio/codimd-cli/blob/v1.0.0/src/commands/whoami.ts)_ |
| 182 | +<!-- commandsstop --> |
| 183 | + |
| 184 | +## `codimd-cli` piping mode |
| 185 | + |
| 186 | +You can create a note by piping text stream to codimd-cli |
| 187 | + |
| 188 | +``` |
| 189 | +USAGE |
| 190 | + $ codimd-cli [COMMAND] |
| 191 | +
|
| 192 | +EXAMPLE |
| 193 | + $ cat README.md | codimd-cli |
| 194 | +
|
| 195 | + Your note is available at https://codimd.domain/note-url |
| 196 | +``` |
0 commit comments