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
30 changes: 18 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,30 +24,36 @@ App ID: `org.tunaos.BlueShell`

## Installation

### TunaOS Flatpak remote

> Available once the [tuna-os promotion](docs/TUNA_OS_PROMOTION.md) lands;
> until then use the nightly bundle below.
### TunaOS Flatpak remote (recommended)

```sh
flatpak remote-add --if-not-exists tuna-os https://tunaos.org/flatpak/tuna-os.flatpakrepo
flatpak install tuna-os org.tunaos.BlueShell
```

Updates then arrive through normal `flatpak update`. The app is listed on
[tunaos.org](https://tunaos.org/) alongside the other TunaOS apps.
Updates then arrive through normal `flatpak update`. Both x86_64 and aarch64
are published, and every commit to `ptyxis-port` refreshes the remote. The app
is listed on [tunaos.org](https://tunaos.org/) alongside the other TunaOS apps.

### Flatpak — one-line install (nightly bundle)
### Flatpak bundle — direct download

CI builds a fresh Flatpak bundle on every commit to `ptyxis-port`. Install the latest:
The same builds are attached to the rolling
[`tip`](https://github.com/tuna-os/blueshell/releases/tag/tip) release, so
these URLs always serve the newest `ptyxis-port` build:

```sh
curl -L https://nightly.link/tuna-os/blueshell/workflows/ghostty-ptyxis/ptyxis-port/BlueShell.flatpak.zip \
-o BlueShell.flatpak.zip \
&& unzip -o BlueShell.flatpak.zip \
&& flatpak install --user --reinstall BlueShell.flatpak
# x86_64
curl -LO https://github.com/tuna-os/blueshell/releases/download/tip/blueshell-x86_64.flatpak
flatpak install --user --reinstall blueshell-x86_64.flatpak

# aarch64
curl -LO https://github.com/tuna-os/blueshell/releases/download/tip/blueshell-aarch64.flatpak
flatpak install --user --reinstall blueshell-aarch64.flatpak
```

Bundles installed this way don't auto-update — re-run the commands, or use the
remote above.

### Flatpak — build from source

```sh
Expand Down
12 changes: 5 additions & 7 deletions docs/TUNA_OS_PROMOTION.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,17 +115,15 @@ Being installable is not the finish line — the app must be discoverable:
(`02-prefs-appearance.png` shows the app best) and a link back to
`tuna-os/blueshell`.

2. **README install instructions**: the README's "TunaOS Flatpak
remote" section is already written (currently marked as pending
promotion) — remove the "available once…" note and promote it to
the recommended install path in the same PR that flips the app ID.
2. **README install instructions**: ✅ DONE — the "available once…"
note is gone and the remote is the recommended path.

## 5. Post-promotion checklist

- [ ] `ptyxis-tests` and `ghostty-ptyxis` (bundle) workflows green in the org repo
- [ ] `publish-flatpak` run pushed an image to `ghcr.io/tuna-os/blueshell` and the index PR/commit landed in `tuna-os/docs`
- [x] `ptyxis-tests` and `ghostty-ptyxis` (bundle) workflows green in the org repo
- [x] `publish-flatpak` run pushed an image to `ghcr.io/tuna-os/blueshell` and the index PR/commit landed in `tuna-os/docs`
- [ ] Fresh-machine install from the remote verified (`flatpak install tuna-os org.tunaos.BlueShell`)
- [ ] README install section switched to the remote as the primary path (nightly.link bundle stays as the "bleeding edge" alternative)
- [x] README install section switched to the remote as the primary path (the rolling `tip` release is the "bleeding edge" alternative)
- [ ] tunaos.org apps page lists BlueShell with install command + screenshot (PR to `tuna-os/docs`)
- [ ] `upstream-sync.yml` weekly run confirmed working under the org (issue/PR creation permissions)
- [ ] Old repo redirect verified; announce the move in tunaOS channels
Loading