Installing Curvenote

The Curvenote CLI is published on npm as curvenote and runs on Node.js 20.19, 22.12 or 24 (or a later release in those lines). If you don’t have Node.js yet, follow Installing Node.js first.

🛠️ Install the CLI globally:

npm install -g curvenote

This adds two commands to your PATH: curvenote, and cn, a shorter name for the same thing. Check that it worked by printing the version:

curvenote --version

Run curvenote on its own, or curvenote <command> --help, to list the commands and their options; the same list is in the command reference.

Note

If the install fails, open an issue with the output, or email support@curvenote.com.

Updating Curvenote

New releases come out every few weeks. Update to the latest with:

npm update -g curvenote

Run curvenote --version before and after to see the change, and compare it with the latest version on npm. If the version doesn’t change, uninstall it with npm uninstall -g curvenote (and without -g if you also installed it in a project) until curvenote is no longer on your command line, then install it again.

Next steps

Sign in if you will deploy or submit to Curvenote; building and previewing work without an account. Then install the VS Code extension for help writing MyST, and create your first project with curvenote init.

Abbreviations
CLI
Command Line Interface
MyST
Markedly Structured Text