runpane

Install or configure Pane from npm.

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:

npx --yes runpane@latest

Persistent install:

npm i -g runpane
runpane setup

The wizard can install Pane on this machine, configure this machine as a remote host, update Pane, or run diagnostics.

Developing This Repository

When debugging RunPane from a Pane repository checkout, prefer the built local wrapper over npx --yes runpane@latest so diagnostics exercise local changes:

PATH=/opt/homebrew/opt/node@22/bin:$PATH node packages/runpane/dist/cli.js doctor --json

doctor remains the first diagnostic command before local-control actions. On macOS it reads installed app bundle metadata and must not launch Pane.app/Contents/MacOS/Pane --version.

Advanced

Explicit Commands

npx --yes runpane@latest setup
npx --yes runpane@latest install client
npx --yes runpane@latest install daemon --label "My Server"
npx --yes runpane@latest update
npx --yes runpane@latest doctor

runpane install daemon installs Pane and then invokes the installed executable with --remote-setup, preserving the pane-remote://... connection-code output.

Package Managers

One-shot execution:

pnpm dlx runpane@latest
yarn dlx runpane@latest
bunx runpane@latest

Persistent install:

npm i -g runpane
runpane setup

pnpm add -g 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

npm package downloads use source=npm 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 npm Trusted Publishing from GitHub Actions. Token-based NPM_TOKEN publishing is a fallback for first package reservation or manual publication only.