Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,7 @@
<br />
<br />

<details>
<summary><sub>Other install methods</sub></summary>
<br />
**Package-manager alternatives**

<sub>pnpm</sub><br />
<pre><code>pnpm dlx runpane@latest</code></pre>
Expand All @@ -46,12 +44,16 @@
<pre><code>npm i -g runpane
runpane setup</code></pre>

**Shell installers**

<sub>Mac / Linux shell installer</sub><br />
<pre><code>curl -fsSL https://runpane.com/install.sh | sh</code></pre>

<sub>Windows PowerShell installer</sub><br />
<pre><code>irm https://runpane.com/install.ps1 | iex</code></pre>

**Direct downloads**

<a href="https://runpane.com/api/download?platform=mac&source=readme">
<img src="https://img.shields.io/badge/Download_for_macOS-000?style=for-the-badge&logo=apple&logoColor=white" height="40" alt="Download for macOS">
</a>
Expand All @@ -62,8 +64,6 @@ runpane setup</code></pre>
<img src="https://img.shields.io/badge/Download_for_Linux-FCC624?style=for-the-badge&logo=linux&logoColor=black" height="40" alt="Download for Linux">
</a>

</details>

<br />
<br />

Expand Down Expand Up @@ -204,7 +204,7 @@ npx --yes runpane@latest
The wizard can install Pane on this machine, configure this machine as a remote
host, update Pane, or run diagnostics.

### Advanced Install Methods
### Package Manager Commands

Explicit desktop install:

Expand All @@ -221,6 +221,8 @@ npm i -g runpane
runpane setup
```

### Shell Installers

Mac / Linux shell installer:

```bash
Expand Down
16 changes: 16 additions & 0 deletions packages/runpane-py/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,22 @@ 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.

## 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
Expand Down
16 changes: 16 additions & 0 deletions packages/runpane/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,22 @@ 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.

## 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
Expand Down
Loading