Command reference
Each command has its own page with its options and examples. Run curvenote <command> --help for the same list on your command line; cn works anywhere curvenote does.
Write and preview¶
| Command | What it does |
|---|---|
curvenote init | Set up a project in a folder, or start one from GitHub or Curvenote. |
curvenote start | Serve the project as a website that reloads as you write. |
curvenote build | Build PDF, LaTeX, Typst, Word, JATS, MECA and site exports. |
curvenote clean | Remove exports, caches, downloaded templates and temporary files. |
curvenote check | Run a venue’s checks on the project before you submit. |
Publish¶
| Command | What it does |
|---|---|
curvenote deploy | Deploy the project as a site on curve.space or your domain. |
curvenote work | Push a work or a new version of it, list or register works. |
curvenote submit | Submit the work to a venue. |
curvenote submission | List, publish and unpublish submissions. |
curvenote site | Set up the content of a site you manage. |
Account¶
| Command | What it does |
|---|---|
curvenote token | Sign in with an API token, switch accounts, or sign out. |
Projects from the Curvenote editor¶
| Command | What it does |
|---|---|
curvenote clone | Copy a project from the Curvenote editor into a local folder. |
curvenote pull | Bring a cloned project up to date with the editor. |
Options for every command¶
-v,--version: print the version of the CLI.-d,--debug: log every step and the full text of any error. Add it when a command fails and include the output when you report an issue.-h,--help: print the help for the CLI or for a command, as incurvenote build --help.
Commands that publish need you to be signed in. Commands that prompt you accept -y or --yes to take the default answer, which is how you run them in continuous integration.
Abbreviations¶
- API
- Application Programming Interface
- CLI
- Command Line Interface
- JATS
- Journal Article Tag Suite
- Portable Document Format