runpane
Install or configure Pane from PyPI.
The package does not include the Pane desktop runtime. It downloads the correct
Pane release artifact only when you run runpane install or runpane update.
Quick Start
Run the guided setup:
pipx run runpane
Persistent install:
python -m pip install runpane
python -m runpane setup
The wizard can install Pane on this machine, configure this machine as a remote host, update Pane, or run diagnostics.
Advanced
Explicit Commands
pipx run runpane setup
pipx run runpane install client
pipx run runpane install daemon --label "My Server"
pipx run runpane update
pipx run runpane doctor
runpane install daemon installs Pane and then invokes the installed executable
with --remote-setup, preserving the pane-remote://... connection-code output.
Python Runners
One-shot execution:
uvx runpane@latest
Persistent install:
python -m pip install runpane
python -m runpane setup
pipx install runpane
runpane setup
Commands
runpane
runpane setup
runpane install
runpane install client
runpane install daemon
runpane update
runpane version
runpane doctor
runpane --help
Common Options
--version <latest|vX.Y.Z>
--format <auto|appimage|deb|dmg|zip|exe>
--download-dir <path>
--pane-path <path>
--dry-run
--verbose
Daemon setup also forwards Pane remote-host options:
--label <name>
--prefer-tunnel <tailscale|ssh|manual|auto>
--print-only
Watching the Workspace
runpane watch waits for workspace transitions from the Pane daemon without
polling. Under --follow it prints one line per event: READY (a turn ended),
BLOCKED (the agent is waiting on a human), IDLE, STUCK (real unsubmitted
composer text; an agent prompt suggestion never counts), NEW, GONE, EXIT,
plus HEARTBEAT every 60 seconds as proof of life.
runpane watch --self-test
runpane watch --follow
The defaults are responsive: no settle, no batching, all event kinds, IDLE
every 10 minutes. Panes and shell users see every event immediately.
A consumer that pays for every line (an orchestrator that re-reads its whole context per wake-up) opts into cadence shaping instead. This is the recommended orchestrator invocation, budgeted at about 6 wake-ups per active pane per hour worst case, usually 1 to 3:
runpane watch --self-test
runpane watch --follow --kinds agent.ready,agent.blocked,agent.idle,panel.exited,pane.gone --settle 180000 --blocked-settle 30000 --min-interval 600000 --idle-backoff
--kindsdropsagent.busy;BUSYcarries no action.--settle <ms>emitsREADYonly after the panel stays idle that long. ABUSYinside the window cancels it silently, which removes the idle/working flips a pane makes while it waits on subagents.--blocked-settle <ms>does the same forBLOCKED, so a prompt answered in the pane within seconds wakes nobody.--min-interval <ms>holds non-urgent lines and flushes them together at most once per interval.BLOCKEDbypasses it.--idle-backofffiresIDLEat--idle-after, then 30m, 1h, 3h, then daily, and resets on any activity.
These flags require --follow. Pane Chat arms them automatically through its
pane-orchestrator skill, so you only need them for your own scripts. Filter
HEARTBEAT out of any monitor that wakes an agent, and judge a dead watch by a
non-zero exit or a WATCH ERROR line, not by silence. runpane agent-context --command watch --json lists every flag with its default.
Attribution
PyPI package downloads use source=pip when requesting release artifacts from
runpane.com/api/download. If that route is unavailable, the CLI falls back to
matching GitHub release assets and prints a warning.
The wrapper also sends best-effort lifecycle telemetry with a persisted
anonymous install_id. Count distinct wrapper users with
count(DISTINCT properties.install_id) on runpane_wrapper_* events. Set
RUNPANE_TELEMETRY_DISABLED=1 to disable wrapper telemetry.
Maintenance Notes
Keep the npm and PyPI clients in sync with each Pane release. When changing shared installer behavior:
- If release asset names or platforms change, update both npm and PyPI wrapper artifact matching.
- If
runpaneCLI behavior changes, update both clients and the shared smoke tests. - If the website
/api/downloadcontract changes, verify npm and PyPI fallback behavior. - If daemon setup flags change, update docs, README files, and wrapper tests together.
- Keep the CI wrapper matrix green: Linux, macOS, Windows, Node 20/22, and Python 3.8/3.13 (runs on PRs that touch the wrappers or contract).
Publishing
This package should be published through PyPI Trusted Publishing from GitHub
Actions. Token-based PYPI_API_TOKEN publishing is a fallback for first package
reservation or manual publication only.
1 maintainer
Release files for runpane 2.4.112
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| runpane-2.4.112.tar.gz | 82.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| runpane-2.4.112-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 166.9 kB
Release files / runpane-2.4.112.tar.gz
| Download URL | runpane-2.4.112.tar.gz |
|---|---|
| Size | 82.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
770cc00ac87db8e87a675769a5c3d27c90ec6c16b27d01c58d41cd85aaf37cd0
|
|
BLAKE2b-256 checksum How to use checksums |
46301d8cb449c1ed5ddb6b49d64dd47aebbf38a3c3a6af526ece6462a3fc5113
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / runpane-2.4.112-py3-none-any.whl
| Download URL | runpane-2.4.112-py3-none-any.whl |
|---|---|
| Size | 84.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
fa471757f5acf55549781005dcf288fce3c42395f85e7b8a69db65e8f0a43543
|
|
BLAKE2b-256 checksum How to use checksums |
cbdbaeb447c5c87d1e4e008939fe335fed6138a9b627ccd6fcc3667ba9a63a21
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
