JUPYTER-RUN(1)

💖 JUPYTER-RUN(1) 💖

okay bestie, so this whole page is about jupyter-run — the little helper that runs your jupyter apps straight from the command line. she's a User Commands girlie and yes she ate. 🎀

✨ NAME ✨

jupyter-run — helper to run jupyter apps from the command line. that's the whole vibe. 💅

🌸 DESCRIPTION 🌸

Run Jupyter kernel code. that's it. that's the gig. lowkey iconic, highkey powerful. 🦋

🔥 OPTIONS 🔥

okay so first things first, queen: the arguments that take values? they're actually just convenience aliases to full Configurables, and their aliases are listed on the help line. if you wanna see the full configurables, go hit up --help-all. periodt.

• --generate-config — generate default config file. boom, config spawned. ✨
• --debug — set log level to logging.DEBUG (maximize logging output). she's LOUD and she's telling you everything. 😭
• --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. you can also set this in the config file by setting c.JupyterConsoleApp.confirm_exit. 👑
• --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. 🫶
• -y — answer yes to any questions instead of prompting. yes-girl mode: activated. 💅
• --existing — connect to an existing kernel. if no argument specified, guess most recent. she'll find her ex, don't worry. 🙈
• --transport=<CaselessStrEnum> (JupyterConsoleApp.transport) — Default: 'tcp' Choices: ['tcp', 'ipc']. pick your transport, bestie. 🌈
• --hb=<Int> (JupyterConsoleApp.hb_port) — Default: 0 set the heartbeat port [default: random]. 💓
• --ssh=<Unicode> (JupyterConsoleApp.sshserver) — Default: '' the SSH server to use to connect to the kernel. 🧚
• --ip=<Unicode> (JupyterConsoleApp.ip) — Default: '' 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! literally be careful. no cap. 🚨
• --kernel=<Unicode> (JupyterConsoleApp.kernel_name) — Default: 'python' the name of the default kernel to start. 🐍
• --log-level=<Enum> (Application.log_level) — Default: 30 Choices: (0, 10, 20, 30, 40, 50, 'DEBUG', 'INFO', 'WARN', 'ERROR', 'CRITICAL') set the log level by value or name. 📊
• --stdin=<Int> (JupyterConsoleApp.stdin_port) — Default: 0 set the stdin (ROUTER) port [default: random]. 📥
• --config=<Unicode> (JupyterApp.config_file) — Default: '' full path of a config file. 📁
• --iopub=<Int> (JupyterConsoleApp.iopub_port) — Default: 0 set the iopub (PUB) port [default: random]. 📡
• --shell=<Int> (JupyterConsoleApp.shell_port) — Default: 0 set the shell (ROUTER) port [default: random]. 🐚
• -f <Unicode> (JupyterConsoleApp.connection_file) — Default: '' 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. 🔑
• --existing=<CUnicode> (JupyterConsoleApp.existing) — Default: '' connect to an already running kernel. again. she's persistent. 💀

🎀 CLASS PARAMETERS 🎀

so parameters get set from command-line arguments that look like this:

--Class.trait=value

this line is evaluated in Python, so simple expressions are allowed, e.g.: --C.a='range(3)' for setting C.a=[0,1,2]. yes she speaks Python, she's multilingual. 👑

⭐ RUNAPP OPTIONS ⭐

• --RunApp.answer_yes=<Bool> — Default: False answer yes to any prompts. ✅
• --RunApp.config_file=<Unicode> — Default: '' full path of a config file. 📁
• --RunApp.config_file_name=<Unicode> — Default: '' specify a config file to load. 📂
• --RunApp.confirm_exit=<CBool> — Default: True set to display confirmation dialog on exit. you can always use 'exit' or 'quit' to force a direct exit without any confirmation. 🫶
• --RunApp.connection_file=<Unicode> — Default: '' 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. 🔑
• --RunApp.control_port=<Int> — Default: 0 set the control (ROUTER) port [default: random]. 🎛️
• --RunApp.existing=<CUnicode> — Default: '' connect to an already running kernel. 👀
• --RunApp.generate_config=<Bool> — Default: False generate default config file. ✨
• --RunApp.hb_port=<Int> — Default: 0 set the heartbeat port [default: random]. 💓
• --RunApp.iopub_port=<Int> — Default: 0 set the iopub (PUB) port [default: random]. 📡
• --RunApp.ip=<Unicode> — Default: '' 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! fr fr. 🚨
• --RunApp.kernel_name=<Unicode> — Default: 'python' the name of the default kernel to start. 🐍
• --RunApp.kernel_timeout=<Float> — Default: 60 timeout for giving up on a kernel (in seconds). on first connect and restart, the console tests whether the kernel is running and responsive by sending kernel_info_requests. this sets the timeout in seconds for how long the kernel can take before being presumed dead. she's just checking if you're still alive bestie 😭
• --RunApp.log_datefmt=<Unicode> — Default: '%Y-%m-%d %H:%M:%S' the date format used by logging formatters for %(asctime)s. 📅
• --RunApp.log_format=<Unicode> — Default: '[%(name)s]%(highlevel)s %(message)s' the Logging format template. 📝
• --RunApp.log_level=<Enum> — Default: 30 Choices: (0, 10, 20, 30, 40, 50, 'DEBUG', 'INFO', 'WARN', 'ERROR', 'CRITICAL') set the log level by value or name. 📊
• --RunApp.shell_port=<Int> — Default: 0 set the shell (ROUTER) port [default: random]. 🐚
• --RunApp.sshkey=<Unicode> — Default: '' path to the ssh key to use for logging in to the ssh server. 🗝️
• --RunApp.sshserver=<Unicode> — Default: '' the SSH server to use to connect to the kernel. 🧚
• --RunApp.stdin_port=<Int> — Default: 0 set the stdin (ROUTER) port [default: random]. 📥
• --RunApp.transport=<CaselessStrEnum> — Default: 'tcp' Choices: ['tcp', 'ipc']. 🌈

and that's the whole page, bestie!! 💖✨🎀

this lil masterpiece is from jupyter-run 5.0.1, dated April 2017 — yeah she's a vintage queen and she still serves. go run some kernels, you got this 👑💅🦋