// installthe script, verified — what it actually does
Install Orphus
No toolchain, no clone. One command installs the release binary:
$ curl -fsSL orphus.dev/install.sh | sh
orphus.dev/install.sh redirects to the script in the repository — read the source before you pipe it to sh.
What the script does
- Detects your platform — macOS arm64 (Apple silicon) or Linux x64 glibc today. It refuses politely on unsupported platforms rather than guessing.
- Downloads the newest release archive from GitHub Releases.
- Verifies the archive against the release's
SHA256SUMSbefore unpacking anything. - Installs to
~/.local/share/orphusand linksorphusinto~/.local/bin.
Staying current
From then on, orphus update upgrades in place: it checks the repository's releases, re-runs the installer, and flips the current pointer — the previous version stays on disk for rollback. A stable install tracks stable releases only, so it is never dragged onto a beta.
Options
| --ref v2.1.0 | Pin an exact release tag instead of the newest. |
| ORPHUS_INSTALL_DIR | Installation root (default ~/.local/share/orphus). |
| ORPHUS_BIN_DIR | Directory for the orphus link (default ~/.local/bin). |
| install.sh --help | Full usage, including token env vars for API rate limits. |
After installing
$ orphus # start a session; /login sets credentials $ orphus inspect runtime --json # what this session actually resolved to
Add an API key for whichever provider you use, or log in from inside a session with /login. Building from a clone instead — including the Rust toolchain the native bindings need — is covered in getting started.