Skip to content

installation.md

Latest commit

 

History

History
100 lines (73 loc) · 2.54 KB

installation.md

File metadata and controls

100 lines (73 loc) · 2.54 KB

Installation

Garyx ships as a single CLI binary. The shell installer downloads the latest release, verifies its checksum, and installs garyx to /usr/local/bin by default. It does not initialize config, start the gateway, or re-sign the release binary.

Install the CLI

::: code-group

curl -fsSL https://raw.githubusercontent.com/Pyiner/garyx/main/install.sh | bash
brew tap pyiner/garyx
brew install pyiner/garyx/garyx
git clone https://github.com/Pyiner/garyx
cd garyx
scripts/install-local-cli.sh

:::

Verify the install:

garyx --version
garyx doctor

Start the gateway

Start the managed background service before onboarding. This command writes the launchd plist on macOS or the systemd user unit on Linux, then starts the gateway:

garyx gateway install

Onboard Garyx

garyx.json lives at ~/.garyx/garyx.json. Generate a minimal one with:

garyx onboard

That seeds an api channel account, default agents, and the gateway block. When the gateway is already running, onboarding asks it to reload the updated config after saving.

::: tip Strings support ${VAR} and ${VAR:-default} env-var expansion at load time, so secrets can stay out of the file. See Configuration for the full schema. :::

Use garyx gateway restart --no-wake after config changes when no active thread needs to be resumed. Use garyx gateway stop to stop the service.

For one-off testing, run it in the foreground:

garyx gateway run

Runtime warnings and provider/channel errors land in ~/.garyx/logs/stderr.log, which is what garyx logs tail reads by default.

::: info On macOS the launchd plist re-enters your login shell with sh -c "exec $LOGIN_SHELL -lic …", so anything you export in ~/.zshenv, ~/.zprofile, or ~/.zshrc is visible to the gateway. That is the recommended place for provider tokens like CLAUDE_CODE_OAUTH_TOKEN. :::

Verify the gateway

curl -s http://127.0.0.1:31337/health
garyx status
garyx doctor

If those checks pass, the gateway is healthy. The next useful step is adding a Telegram bot so real messages can enter Garyx through a channel.

Where to go next