Environment variables
Edit on GitHubA variable and the config key it stands for are the same setting. Where both exist, the variable wins for that one process.
Using orrery
| Variable | Effect |
|---|---|
HOME · USERPROFILE | Where ~/.orrery is: your user layer, trust answers, extensions, skills and agents. |
ORRERY_THEME | The palette the TUI starts in. |
NO_COLOR · TERM=dumb | Draw in mono. |
ORRERY_GRAPHICS | How the animated mark is drawn: kitty, iterm2, sixel or none. Overrides the terminal probe. |
ORRERY_NODE_TOKEN | The token orrery attach presents, instead of --token. |
ORRERY_NO_AUTOSTART | 1: orrery node join does not install the start-at-login. Same as --no-autostart. |
ORRERY_TLS_CA | A PEM file of extra certificate authorities, for the relay and the control plane. Same as cloud.tls_ca. |
Provider keys
A provider reads the variables it declares when its own table has no apiKey, for example GEMINI_API_KEY or ANTHROPIC_API_KEY. orrery providers status shows which one a setup uses.
Any variable can be named from a config file as "$VAR":
[providers.groq]
apiKey = "$GROQ_API_KEY"The installer
Read by install.sh and install.ps1 only.
| Variable | Effect |
|---|---|
ORRERY_VERSION | Install this version instead of the latest. |
ORRERY_INSTALL_DIR | Where the binary goes. |
ORRERY_WITH_RELAY | 1 also installs orrery-relay. |
ORRERY_RELAY | Join this relay with a device code, then start the node at login. |
ORRERY_JOIN_ENV | A cloud instance's join file: join without a device code. |
ORRERY_JOIN_KIND | In a join file: instance (default) or machine, the kind of one-time token it holds. |
ORRERY_MANIFEST_URL | The release manifest to read. |
Set by orrery for what it starts
Read these in a client or extension; do not set them yourself.
| Variable | Meaning |
|---|---|
ORRERY_ENDPOINT | The channel a client extension talks to the host on. |
ORRERY_TOKEN | A one-time secret for that channel. |
ORRERY_CONFORMANCE | 1 when orrery install starts a client in probe mode to check its fixtures. |