Command line interface#
Program to open jupyter notebooks from central notebook server.
usage: open-notebook [-h] [--host HOST] [-p PORT] [-r ROOT] [--dir-prefix DIR_PREFIX] [--file-prefix FILE_PREFIX] [--reset] [-c CONFIG] [--create-config] [--overwrite] [--version] [-v] [--dry] [paths ...]
Positional Arguments#
- paths
file or paths to open
Named Arguments#
- --host
Host name (default=’localhost’)
- -p, --port
Port (default=’8888’)
- -r, --root
Directory servers was started in. Defaults to current working directory.
- --dir-prefix
Directory prefix (default=’tree’)
- --file-prefix
File prefix (default=’notebooks’)
- --reset
- -c, --config
Config style to use. This is the name of a header in one of the config files.
- --create-config
If passed, create .open-notebook.ini
- --overwrite
Pass to overwrite ~/.open-notebook.toml if it exists with –create-config
- --version
Print out program version
- -v, --verbose
Set verbosity level. Can pass multiple times.
- --dry
Dry run.
You can set options with the configuration files “.open-notebook.toml”. Configuration files are found in the current directory, git root (if in a git tracked tree), and the home directory. Note that all these files are considered, in order. That is, you could override a single value in the current directory, and the rest would be inherited from, in order, git root and then the home directory.