OS Manuals

/opt/chainguard/jupyterhub-k8s-singleuser-sample/bin/jupyter-run

JupyterHub single-user notebook server sample (JupyterLab) from zero-to-jupyterhub-k8s

From jupyterhub-k8s-singleuser-sample 4.4.5-r0 (enterprise-packages), captured 2026-11-08 by running jupyter-run --help (exit 0). permalink

Run Jupyter kernel code.

Options
=======
The options below are convenience aliases to configurable class-options,
as listed in the "Equivalent to" description-line of the aliases.
To see all configurable class-options for some <cmd>, use:
    <cmd> --help-all

--debug
    set log level to logging.DEBUG (maximize logging output)
    Equivalent to: [--Application.log_level=10]
--show-config
    Show the application's configuration (human-readable format)
    Equivalent to: [--Application.show_config=True]
--show-config-json
    Show the application's configuration (json format)
    Equivalent to: [--Application.show_config_json=True]
--generate-config
    generate default config file
    Equivalent to: [--JupyterApp.generate_config=True]
-y
    Answer yes to any questions instead of prompting.
    Equivalent to: [--JupyterApp.answer_yes=True]
--existing
    Connect to an existing kernel. If no argument specified, guess most recent
    Equivalent to: [--JupyterConsoleApp.existing=kernel*.json]
--confirm-exit
    Set to display confirmation dialog on exit. You can always use 'exit' or
           'quit', to force a direct exit without any confirmation. This can also
           be set in the config file by setting
           `c.JupyterConsoleApp.confirm_exit`.
    Equivalent to: [--JupyterConsoleApp.confirm_exit=True]
--no-confirm-exit
    Don't prompt the user when exiting. This will terminate the kernel
           if it is owned by the frontend, and leave it alive if it is external.
           This can also be set in the config file by setting
           `c.JupyterConsoleApp.confirm_exit`.
    Equivalent to: [--JupyterConsoleApp.confirm_exit=False]
--log-level=<Enum>
    Set the log level by value or name.
    Choices: any of [0, 10, 20, 30, 40, 50, 'DEBUG', 'INFO', 'WARN', 'ERROR', 'CRITICAL']
    Default: 30
    Equivalent to: [--Application.log_level]
--config=<Unicode>
    Full path of a config file.
    Default: ''
    Equivalent to: [--JupyterApp.config_file]
--ip=<Unicode>
    Set the kernel's IP address [default localhost]. If the IP address is
    something other than localhost, then Consoles on other machines will be able
    to connect to the Kernel, so be careful!
    Default: ''
    Equivalent to: [--JupyterConsoleApp.ip]
--transport=<CaselessStrEnum>
    Choices: any of ['tcp', 'ipc'] (case-insensitive)
    Default: 'tcp'
    Equivalent to: [--JupyterConsoleApp.transport]
--hb=<Int>
    set the heartbeat port [default: random]
    Default: 0
    Equivalent to: [--JupyterConsoleApp.hb_port]
--shell=<Int>
    set the shell (ROUTER) port [default: random]
    Default: 0
    Equivalent to: [--JupyterConsoleApp.shell_port]
--iopub=<Int>
    set the iopub (PUB) port [default: random]
    Default: 0
    Equivalent to: [--JupyterConsoleApp.iopub_port]
--stdin=<Int>
    set the stdin (ROUTER) port [default: random]
    Default: 0
    Equivalent to: [--JupyterConsoleApp.stdin_port]
--control=<Int>
    set the control (ROUTER) port [default: random]
    Default: 0
    Equivalent to: [--JupyterConsoleApp.control_port]
--existing=<CUnicode>
    Connect to an already running kernel
    Default: ''
    Equivalent to: [--JupyterConsoleApp.existing]
-f=<Unicode>
    JSON file in which to store connection info [default: kernel-<pid>.json]

    This file will contain the IP, ports, and authentication key needed to
    connect clients to this kernel. By default, this file will be created in the
    security dir of the current profile, but can be specified by absolute path.
    Default: ''
    Equivalent to: [--JupyterConsoleApp.connection_file]
--kernel=<Unicode>
    The name of the default kernel to start.
    Default: 'python'
    Equivalent to: [--JupyterConsoleApp.kernel_name]
--ssh=<Unicode>
    The SSH server to use to connect to the kernel.
    Default: ''
    Equivalent to: [--JupyterConsoleApp.sshserver]
--sshkey=<Unicode>
    Path to the ssh key to use for logging in to the ssh server.
    Default: ''
    Equivalent to: [--JupyterConsoleApp.sshkey]

To see all available configurables, use `--help-all`.
Options (21)
OptionDescriptionSource
--debugset log level to logging.DEBUG (maximize logging output) Equivalent to: [--Application.log_level=10]help
--show-configShow the application's configuration (human-readable format) Equivalent to: [--Application.show_config=True]help
--show-config-jsonShow the application's configuration (json format) Equivalent to: [--Application.show_config_json=True]help
--generate-configgenerate default config file Equivalent to: [--JupyterApp.generate_config=True]help
-yAnswer yes to any questions instead of prompting.help
--existingConnect to an existing kernel.help
--confirm-exitSet to display confirmation dialog on exit.help
--no-confirm-exitDon't prompt the user when exiting.help
--log-level EnumSet the log level by value or name.help
--config UnicodeFull path of a config file.help
--ip UnicodeSet the kernel's IP address [default localhost].help
--transport CaselessStrEnumChoices: any of ['tcp', 'ipc'] (case-insensitive) Default: 'tcp' Equivalent to: [--JupyterConsoleApp.transport]help
--hb Intset the heartbeat port [default: random] Default: 0 Equivalent to: [--JupyterConsoleApp.hb_port]help
--shell Intset the shell (ROUTER) port [default: random] Default: 0 Equivalent to: [--JupyterConsoleApp.shell_port]help
--iopub Intset the iopub (PUB) port [default: random] Default: 0 Equivalent to: [--JupyterConsoleApp.iopub_port]help
--stdin Intset the stdin (ROUTER) port [default: random] Default: 0 Equivalent to: [--JupyterConsoleApp.stdin_port]help
--control Intset the control (ROUTER) port [default: random] Default: 0 Equivalent to: [--JupyterConsoleApp.control_port]help
-f UnicodeJSON file in which to store connection info [default: kernel-<pid>.json]help
--kernel UnicodeThe name of the default kernel to start.help
--ssh UnicodeThe SSH server to use to connect to the kernel.help
--sshkey UnicodePath to the ssh key to use for logging in to the ssh server.help

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.