BETAv0.24.11
GitHub Install
Install
Docs/Start/Install

Install

Edit on GitHub
docs-site/start/install.md

Orrery has two parts you can install on their own:

  • orrery, the command-line harness: the TUI, one-shot runs, the node.
  • The ADE, the desktop app. Its Agent mode runs orrery sessions; its IDE mode runs any CLI agent.

You only need the ADE if you want the desktop app. Everything in these docs works with orrery alone.

Install orrery

On Linux, macOS (Apple silicon) or Git Bash:

curl -fsSL https://getorrery.dev/install.sh | sh

On Windows, in PowerShell:

irm https://getorrery.dev/install.ps1 | iex

The installer reads the release manifest (harness-latest.json in kouji-dev/orrery-releases), downloads the archive for your machine and checks its sha256 before it writes anything.

It installs orrery to:

  • /usr/local/bin when you are root or it is writable, otherwise ~/.local/bin;
  • ~\.orrery\bin on Windows, added to your user PATH.

Release builds carry every provider. Run the installer again to upgrade in place.

Installer settings

All optional, as environment variables:

VariableWhat it does
ORRERY_VERSION=0.2.0Install that version instead of the latest.
ORRERY_INSTALL_DIR=DIRInstall into DIR.
ORRERY_WITH_RELAY=1Also install orrery-relay, for a self-hosted relay.
ORRERY_RELAY=URLThen join that relay with a device code and start the node at login.
ORRERY_JOIN_ENV=FILEA cloud instance's join file: join without a device code.
ORRERY_MANIFEST_URL=URLRead another release manifest (a mirror, a test).
curl -fsSL https://getorrery.dev/install.sh | ORRERY_VERSION=0.2.0 sh

Check it

orrery --version
orrery providers

--version prints the version. orrery providers lists every model provider installed. The installer puts Orrery's own extensions (the tools, the providers, the terminal client) in ~/.orrery/extensions; running it again updates them.

Build from source

If no release exists for your machine yet, build it with Rust (stable):

cargo install --git https://github.com/kouji-dev/orrery orrery-cli

That builds orrery alone. Its extensions — model providers included — load from ~/.orrery/extensions and the project's .orrery/extensions: from a checkout, cargo xtask dev-extensions --shipped builds them and copies them into ~/.orrery/extensions; otherwise add one with orrery install <source>.

Install the ADE

Download the installer from the latest release: -setup.exe or .msi on Windows. A macOS build is not published yet.

The ADE does not ship orrery. The first time you open Agent mode without it, the ADE offers to install it into ~/.orrery/bin, from the same release files and checksums as the scripts above. See Agent mode.

Next

  • Quickstart: a model and a first answer in two minutes.