Skip to content

Add guided runpane setup flow#247

Merged
parsakhaz merged 1 commit into
mainfrom
runpane-setup-wizard
Jun 17, 2026
Merged

Add guided runpane setup flow#247
parsakhaz merged 1 commit into
mainfrom
runpane-setup-wizard

Conversation

@parsakhaz

Copy link
Copy Markdown
Member

Summary

  • add a guided runpane setup flow and no-arg interactive entrypoint for the npm and PyPI wrappers
  • keep CI/non-interactive no-arg and setup invocations safe by printing help instead of hanging for input
  • add visible install/update progress for release resolution, artifact download, install, and remote setup phases
  • update the root/package docs and CLI contract so quick starts lead with one command while explicit commands live under Advanced
  • expand contract and smoke coverage for setup/no-arg behavior across npm, pnpm, and Python package entrypoints

Visual Overview

Before

flowchart LR
  User["User reads README"] --> Matrix["Choose from shell, npm, pnpm, pipx, pip, or direct commands"]
  Matrix --> Explicit["Run explicit install client/daemon/update commands"]
  Explicit --> Quiet["Release lookup and artifact download can look quiet"]
Loading

After

flowchart LR
  User["User reads README"] --> One["Run one command"]
  One --> Wizard["Guided runpane setup"]
  Wizard --> Choice{"Install app, remote host, update, or doctor"}
  Choice --> Progress["Visible progress for resolve, download, install, setup"]
  Progress --> Advanced["Advanced explicit commands remain scriptable"]
Loading

Excalidraw source: /tmp/codex-pr-diagrams/runpane-setup-wizard/overview.excalidraw

Testing

  • pnpm run test:runpane-contract
  • pnpm run test:runpane-package-smoke
  • python3 -m py_compile packages/runpane-py/src/runpane/*.py
  • printf '4\n' | script -q -e -c 'node packages/runpane/dist/cli.js setup' /dev/null
  • printf '4\n' | script -q -e -c 'PYTHONPATH=packages/runpane-py/src python3 -m runpane setup' /dev/null
  • npx --yes -p node@22.15.1 -p pnpm@10.19.0 -c 'pnpm run check:runpane-package-versions && pnpm typecheck && pnpm lint'

pnpm lint completed with the repository's existing warning set and no errors.

Release Notes

  • npx --yes runpane@latest and pipx run runpane now provide a guided first-run setup experience in an interactive terminal.
  • runpane setup is available for users who install the wrapper persistently.
  • Existing explicit commands such as runpane install client, runpane install daemon, runpane update, and runpane doctor remain supported for scripts and advanced users.

@parsakhaz parsakhaz merged commit 37a20aa into main Jun 17, 2026
16 checks passed
@parsakhaz parsakhaz deleted the runpane-setup-wizard branch June 17, 2026 06:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant