orion-notebook 0.6.1

Local Orion CLI launcher for notebooks and Jupyter

orion-notebook

Python launcher for Orion. Installs the orion command on PyPI.

Orion also publishes orion-ui on PyPI — the Python library for notebook UI components (import orion_ui as ui). You do not install it separately when using Orion's managed Jupyter runtime; Orion syncs orion-ui==<version> into ~/.orion/runtime/venv automatically.

Install

pip install orion-notebook
orion

What happens on first run

The PyPI wheel is intentionally small. When you run orion for the first time, the CLI may:

1. Download the Orion app bundle into ~/.orion/app/<version> from a GitHub release
2. Download portable Node.js 20+ into ~/.orion/runtime/node/<version> if Node is not installed
3. Create an Orion-managed Jupyter venv under ~/.orion/runtime/venv if no compatible Jupyter is found (includes Jupyter, ipykernel, and orion-ui)

Each step prompts for consent unless you pass --yes:

orion --yes

Managed Jupyter is installed only inside Orion's venv, not into your global Python.

After the first successful setup, later runs start Jupyter, launch Orion, and open your browser much faster.

Requirements

• Python 3.8+
• Node.js 20+ (downloaded automatically into ~/.orion/runtime/node when missing)

Flags

orion --yes          # auto-approve setup prompts
orion --no-browser   # start services without opening a browser
orion uninstall      # remove cached app bundle for this version (~/.orion/app/<version>)
orion uninstall --all --yes  # remove entire ~/.orion directory

Uninstall

pip uninstall orion-notebook removes the Python launcher only. It does not delete the app bundle downloaded into ~/.orion/app/<version>/. Run this first:

orion uninstall --yes
pip uninstall orion-notebook

To remove all Orion-managed data (Jupyter venv, portable Node, every cached app version):

orion uninstall --all --yes

Environment variables

Variable	Purpose
ORION_HOME_DIR	Override Orion data root (default: ~/.orion)
ORION_APP_BUNDLE_URL	Override app bundle download URL
ORION_PORT	Orion app port (default: 3001)

Default app bundle URL:

https://github.com/nicolasakf/Orion-app/releases/download/v<version>/orion-app-<version>.tar.gz

npm install (recommended)

Both npm and PyPI publish under the name orion-notebook. If you already have Node.js 20+, npm is simpler because it ships the app bundle directly:

npm install -g orion-notebook
orion

See the main README and Contributing for publishing and development details.