Skip to content

Commit 2f01c20

Browse files
Yukaiicursoragent
andcommitted
docs: update CodiMD compatibility notice to point to standalone codimd-cli
Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent 3b28cca commit 2f01c20

1 file changed

Lines changed: 4 additions & 2 deletions

File tree

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,13 @@
1313

1414
## v2 notice
1515

16-
`hackmd-cli` v2 now only supports the official HackMD instance([hackmd.io](https://hackmd.io)) and HackMD EE instances after version `1.38.1`. CodiMD is not supported anymore. If you want to use the CLI tools with CodiMD, please check out the [`v1.x` README](https://github.com/hackmdio/hackmd-cli/tree/v1.2.0) and follow the instruction there.
16+
`hackmd-cli` v2 now only supports the official HackMD instance ([hackmd.io](https://hackmd.io)) and HackMD EE instances after version `1.38.1`. CodiMD is not supported in this package.
17+
18+
**CodiMD users:** A dedicated standalone CLI is now available at [hackmdio/codimd-cli](https://github.com/hackmdio/codimd-cli). Please refer to that repository for installation and usage instructions.
1719

1820
### Migrating from v1.x
1921

20-
1. If you are using the CLI with CodiMD, please follow the [`v1.x` README](https://github.com/hackmdio/hackmd-cli/tree/v1.2.0)
22+
1. If you are using the CLI with CodiMD, please use the standalone [codimd-cli](https://github.com/hackmdio/codimd-cli) instead.
2123
2. If you are using the CLI with HackMD([hackmd.io](https://hackmd.io)) or HackMD EE(Enterprise Edition) instances:
2224
* **You're using the JSON file-based config**: Remove `~/.hackmd/config.json` and start over again. You can start with [configuration](#configuration) section.
2325
* **You're using environment variable based config**: `HMD_CLI_SERVER_URL` has been replaced with `HMD_API_ENDPOINT_URL`. And `HMD_API_ENDPOINT_URL` may vary depending on your instance. Please check contact your instance admin to get the correct `HMD_API_ENDPOINT_URL`. For generating access token, please check the [configuration](#configuration) section. You'll need to set the `HMD_API_ACCESS_TOKEN` environment variable.

0 commit comments

Comments
 (0)