Skip to main content

Thin PyPI installer and remote setup CLI for Pane

Project description

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

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 runpane CLI behavior changes, update both clients and the shared smoke tests.
  • If the website /api/download contract 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 18/22, and Python 3.8/3.13.

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

runpane-2.3.12.tar.gz (42.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

runpane-2.3.12-py3-none-any.whl (45.5 kB view details)

Uploaded Python 3

File details

Details for the file runpane-2.3.12.tar.gz.

File metadata

  • Download URL: runpane-2.3.12.tar.gz
  • Upload date:
  • Size: 42.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for runpane-2.3.12.tar.gz
Algorithm Hash digest
SHA256 422cb72b6c96d7cdaba5c7adc679589bca4b57eef850d2ed242a1dd9059b5da0
MD5 83680954cc90f32f1eec0fb35f734f74
BLAKE2b-256 0c6af13e4633362c2a86b7c1892daf93e07e2e8c2487748d25d7307246231af6

See more details on using hashes here.

File details

Details for the file runpane-2.3.12-py3-none-any.whl.

File metadata

  • Download URL: runpane-2.3.12-py3-none-any.whl
  • Upload date:
  • Size: 45.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for runpane-2.3.12-py3-none-any.whl
Algorithm Hash digest
SHA256 cfd88e9184abeafc4e128c964f0b369f10e0c85ce08157059d3a1cd768caa418
MD5 35665b45de9016c80e5edc633ce4638f
BLAKE2b-256 0d2626d1758aea2e3a53bb3155d6ebc47988ca8693fe47cec4c50ee995b8e55a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page