Skip to content

docs(readme): explain prerelease artifact downloads #3160

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
SDAChess wants to merge 1 commit into
base: main
Choose a base branch
from
+37 −0
Open

docs(readme): explain prerelease artifact downloads #3160

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
37 changes: 37 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,43 @@ curl -LsSf https://raw.githubusercontent.com/NVIDIA/OpenShell/main/install.sh |

The installer installs the latest stable release by default. To install a specific version, set `OPENSHELL_VERSION`. A [`dev` release](https://github.com/NVIDIA/OpenShell/releases/tag/dev) is also available that tracks the latest commit on `main`.

**Prerelease artifacts:**

Tagged prereleases are stored as GitHub Actions artifacts for 90 days. Use the GitHub CLI to find the release workflow run and download its release-shaped artifact set:

```shell
tag=v0.1.0-pre.1
run_id=$(gh run list \
--repo NVIDIA/OpenShell \
--branch "$tag" \
--workflow release-tag.yml \
--json databaseId \
--jq '.[0].databaseId')

gh run download "$run_id" \
--repo NVIDIA/OpenShell \
--name "openshell-$tag" \
--dir "$tag"
```

The downloaded directory contains the same kinds of files published with a stable release. Package managers encode the prerelease version in their native format. For example, the output includes:

```text
v0.1.0-pre.1/openshell_0.1.0~pre.1-1_arm64.deb
v0.1.0-pre.1/openshell-0.1.0-0.pre.1.fc44.aarch64.rpm
v0.1.0-pre.1/openshell-aarch64-unknown-linux-musl.tar.gz
v0.1.0-pre.1/openshell-gateway-aarch64-unknown-linux-gnu.tar.gz
v0.1.0-pre.1/openshell-checksums-sha256.txt
```

To download only the ARM64 Debian package instead, select its workflow artifact:

```shell
gh run download "$run_id" \
--repo NVIDIA/OpenShell \
--name deb-linux-arm64
```

The `openshell` package on PyPI provides the Python SDK only. It does not install the `openshell` CLI. Add the SDK to a Python project with [uv](https://docs.astral.sh/uv/):

```bash
Expand Down
Loading