The following table summarized the main notex commands and their purpose. Use it as a quick reference.
Further details can be obtained running the notex help (or notex -h) command.
| Command | Description |
|---|---|
| notex help | Shows notex binary options and help guide. |
| notex version | Shows current binary version. |
| notex info | Displays installation and current project information. |
| notex init . | Initializes a project in the current working directory. |
| notex clean <path> | Cleans recursively temporary files from the provided <path>. |
| notex get <snippet> | Provides a ready-to-use snippet LaTeX snippet template. |
| notex theme <theme> | Changes the current project theme. |
| notex add <what> | Adds a new section or bibliography (bib) to the current project. |
| notex remove <what> | Removes a section or bibliography (bib) from the current project. |
| notex ls | Lists the files that belong to the current project. |
| notex checkhealth | Checks the TeX environment, the installation, and the project's state. |
| notex set <key> <what> | Changes a whitelisted notex.json key directly. |
| notex reset | Regenerates main.tex from the template. |
| notex delete | Removes notex files and build artefacts, keeps your documents. |