55[ ![ Downloads/week] ( https://img.shields.io/npm/dw/@hackmd/codimd-cli.svg )] ( https://npmjs.org/package/@hackmd/codimd-cli )
66[ ![ License] ( https://img.shields.io/npm/l/@hackmd/codimd-cli.svg )] ( https://github.com/hackmdio/codimd-cli/blob/master/package.json )
77
8- <!-- toc -->
98* [ codimd-cli - The CodiMD Command Line Tool] ( #codimd-cli---the-codimd-command-line-tool )
10- <!-- tocstop -->
119* [ Usage] ( #usage )
1210* [ Commands] ( #commands )
1311* [ Configuration] ( #configuration )
@@ -20,7 +18,7 @@ $ npm install -g @hackmd/codimd-cli
2018$ codimd-cli COMMAND
2119running command...
2220$ codimd-cli (-v| --version| version)
23- @hackmd/codimd-cli/1.0.1 linux-x64 node-v8.17.0
21+ @hackmd/codimd-cli/1.0.2 linux-x64 node-v8.17.0
2422$ codimd-cli --help [COMMAND]
2523USAGE
2624 $ codimd-cli COMMAND
@@ -45,15 +43,15 @@ Change the serverUrl value to your hosted CodiMD instance URL.
4543You can also speicify config as environment variable. For example, append this line to your ` .bashrc ` :
4644
4745``` bash
48- export CMD_CLI_SERVER_URL=my.codimd-domain.dev
46+ export CMD_CLI_SERVER_URL=https:// my.codimd-domain.dev
4947```
5048
5149All available configurations are listed in the table below.
5250
53- | Config key | Environment Variable | Data Type | Example Value | Description |
54- | ------------ | :--------------------- | ---------- | ------------------------ | ------------------------------------ |
55- | ` serverUrl ` | ` CMD_CLI_SERVER_URL ` | * ` string ` * | ` https://my.codimd-domain.dev ` | The CodiMD instance URL |
56- | ` cookiePath ` | ` CMD_CLI_COOKIE_PATH ` | * ` string ` * | ` ~/.codimd/cookies.json ` | File for storing login cookie states |
51+ | Config key | Environment Variable | Data Type | Example Value | Description |
52+ | ------------ | :--------------------- | ---------- | ------------------------------ | ------------------------------------ |
53+ | ` serverUrl ` | ` CMD_CLI_SERVER_URL ` | * ` string ` * | ` https://my.codimd-domain.dev ` | The CodiMD instance URL |
54+ | ` cookiePath ` | ` CMD_CLI_COOKIE_PATH ` | * ` string ` * | ` ~/.codimd/cookies.json ` | File for storing login cookie states |
5755
5856## Commands
5957
@@ -84,7 +82,7 @@ EXAMPLE
8482 $ codimd-cli export [--pdf|--md|--html] <note_id> <output_file>
8583```
8684
87- _ See code: [ src/commands/export.ts] ( https://github.com/hackmdio/codimd-cli/blob/v1.0.1 /src/commands/export.ts ) _
85+ _ See code: [ src/commands/export.ts] ( https://github.com/hackmdio/codimd-cli/blob/v1.0.2 /src/commands/export.ts ) _
8886
8987### ` codimd-cli help [COMMAND] `
9088
@@ -130,7 +128,7 @@ EXAMPLE
130128 EeNHDGocSTi70ytMMGQaaQ Note2
131129```
132130
133- _ See code: [ src/commands/history.ts] ( https://github.com/hackmdio/codimd-cli/blob/v1.0.1 /src/commands/history.ts ) _
131+ _ See code: [ src/commands/history.ts] ( https://github.com/hackmdio/codimd-cli/blob/v1.0.2 /src/commands/history.ts ) _
134132
135133### ` codimd-cli import [FILE] `
136134
@@ -149,7 +147,7 @@ EXAMPLE
149147 Your note is available at https://codimd.domain/note-url
150148```
151149
152- _ See code: [ src/commands/import.ts] ( https://github.com/hackmdio/codimd-cli/blob/v1.0.1 /src/commands/import.ts ) _
150+ _ See code: [ src/commands/import.ts] ( https://github.com/hackmdio/codimd-cli/blob/v1.0.2 /src/commands/import.ts ) _
153151
154152### ` codimd-cli login `
155153
@@ -172,7 +170,7 @@ EXAMPLE
172170 Login as HMD successfully!
173171```
174172
175- _ See code: [ src/commands/login.ts] ( https://github.com/hackmdio/codimd-cli/blob/v1.0.1 /src/commands/login.ts ) _
173+ _ See code: [ src/commands/login.ts] ( https://github.com/hackmdio/codimd-cli/blob/v1.0.2 /src/commands/login.ts ) _
176174
177175### ` codimd-cli logout `
178176
@@ -191,7 +189,7 @@ EXAMPLE
191189 You've logged out successfully
192190```
193191
194- _ See code: [ src/commands/logout.ts] ( https://github.com/hackmdio/codimd-cli/blob/v1.0.1 /src/commands/logout.ts ) _
192+ _ See code: [ src/commands/logout.ts] ( https://github.com/hackmdio/codimd-cli/blob/v1.0.2 /src/commands/logout.ts ) _
195193
196194### ` codimd-cli whoami `
197195
@@ -210,10 +208,10 @@ EXAMPLE
210208 You are logged in codimd.domain as {YOUR NAME} [user-id]
211209```
212210
213- _ See code: [ src/commands/whoami.ts] ( https://github.com/hackmdio/codimd-cli/blob/v1.0.1 /src/commands/whoami.ts ) _
211+ _ See code: [ src/commands/whoami.ts] ( https://github.com/hackmdio/codimd-cli/blob/v1.0.2 /src/commands/whoami.ts ) _
214212<!-- commandsstop -->
215213
216- #### ` codimd-cli ` piping mode
214+ ### ` codimd-cli ` piping mode
217215
218216You can create a note by piping text stream to codimd-cli
219217
0 commit comments