CLI Documentation¶
This section of the documentation documents all the commands, arguments and actions available on the notabene CLI.
notabene template¶
Create, use and check notebook template cli-subsection.
notabene template [OPTIONS] COMMAND [ARGS]...
Options
- -t, --template-dir <template_dir>¶
check¶
Check that all notebooks in this project match to at least one template.
notabene template check [OPTIONS]
create¶
Create a new template from an existing NOTEBOOK.
notabene template create [OPTIONS] NOTEBOOK
Options
- -n, --name <name>¶
The name of the new template. An option prompt is shown if left empty.
Arguments
- NOTEBOOK¶
Required argument
list¶
List all of the templates registered in this project.
notabene template list [OPTIONS]
use¶
Use one of your templates to create a new notebook.
NOTEBOOK is the name of the new notebook. Adding .ipynb is optional.
notabene template use [OPTIONS] NOTEBOOK
Options
- -t, --template <template>¶
The name or index of a template. An option prompt is shown by default.
Arguments
- NOTEBOOK¶
Required argument