Skip to main content
The runt command-line tool provides utilities for managing notebooks, kernels, and the background daemon.

​
Installation

The CLI is bundled with the nteract Desktop app. After installing nteract, the runt command is available in your PATH.
On macOS, the CLI is located at /Applications/nteract.app/Contents/MacOS/runt. The installer automatically adds this to your PATH.

​
Quick Start

runt notebook path/to/notebook.ipynb

​
Command Structure

The CLI is organized into subcommands:
CommandDescription
runt notebookOpen the notebook application
runt consoleLaunch an interactive Jupyter console
runt notebooksList open notebooks with kernel info
runt daemonDaemon service management
runt jupyterStandalone kernel management
runt shutdownShutdown a notebook’s kernel

​
Global Options

Most commands support:
  • --json — Output results in JSON format
  • --help — Show help for the command

​
Usage Examples

​
Open a notebook

# Open an existing notebook
runt notebook analysis.ipynb

# Open with specific runtime
runt notebook --runtime python new.ipynb
runt notebook --runtime deno script.ipynb

​
List open notebooks

$ runt notebooks
╭──────────────────────────────────────┬────────┬──────────────┬────────┬───────╮
│ NOTEBOOK                             │ KERNEL │ ENV          │ STATUS │ PEERS │
├──────────────────────────────────────┼────────┼──────────────┼────────┼───────┤
│ ~/notebooks/blobstore.ipynb          │ python │ uv:inline    │ idle   │ 1     │
│ d4c441d3-d862-4ab0-afe6-ff9145cc2f3d │ python │ uv:prewarmed │ idle   │ 1     │
╰──────────────────────────────────────┴────────┴──────────────┴────────┴───────╯

​
Check daemon health

runt daemon status
runt daemon logs -f

​
Exit Codes

Commands return standard exit codes:
  • 0 — Success
  • 1 — Error (daemon not running, kernel not found, etc.)

​
Next Steps

Notebook Command

Launch notebooks and manage the desktop app

Console Command

Interactive REPL for Jupyter kernels

Daemon Commands

Service management and troubleshooting

Kernel Management

Standalone kernel lifecycle commands

Build docs developers (and LLMs) love

Get started for freeTalk to us