index.md

layout	home
hero	name text tagline image actions Garyx Local-first AI agent gateway Run provider-backed agents from Telegram, Feishu / Lark, WeChat, CLI, HTTP / WebSocket, MCP, automations, and the macOS app with one shared thread history. src alt /logo.svg Garyx logo theme text link brand Install Garyx /installation theme text link alt Connect Telegram /first-bot theme text link alt GitHub https://github.com/Pyiner/garyx
features	title details Channel gateway Telegram, Feishu / Lark, WeChat, subprocess channel plugins, and a local API channel all share the same routing model. title details Provider bridge Route threads to Claude Code, Codex, Gemini, custom agents, or teams while keeping channel setup stable. title details Persistent threads Conversations keep transcript history, endpoint bindings, provider resume state, and workspace context across surfaces. title details Scoped MCP Every run gets a per-thread Garyx MCP endpoint plus the upstream MCP servers configured for that gateway. title details Tasks and automations Promote work into reviewable tasks or schedule recurring prompts that deliver through Garyx. title details macOS desktop Use the native app for browsing threads, folders, agents, tasks, gateway settings, and live runs.

The shape

Garyx is the local process that turns many entry points into one durable agent runtime.

Telegram / Feishu / WeChat / CLI / Desktop / HTTP / WebSocket
  -> Garyx gateway
  -> Threads, transcripts, endpoint bindings, tasks, automations
  -> Claude Code / Codex / Gemini / custom agents / teams
  -> Garyx MCP tools and configured upstream MCP servers

It is not a hosted agent platform. The gateway, config, channel accounts, and transcripts live on the machine or server where you run Garyx.

Install, then connect Telegram

The release installer only installs the CLI binary. It downloads the latest release, verifies its checksum, and installs garyx to /usr/local/bin by default. It does not initialize Garyx, start the gateway, or re-sign the release binary. The normal first run is: install the CLI, start the managed gateway service, run onboarding, then register a Telegram bot.

::: code-group

curl -fsSL https://raw.githubusercontent.com/Pyiner/garyx/main/install.sh | bash
garyx --version

garyx gateway install
garyx onboard
garyx status

export TELEGRAM_BOT_TOKEN="TOKEN_FROM_BOTFATHER"
garyx channels add telegram main --token "$TELEGRAM_BOT_TOKEN" --agent claude
garyx gateway restart --no-wake

:::

Why it exists

Meet users where they already are

Keep Telegram DMs, Feishu group mentions, WeChat chats, CLI sends, desktop threads, and API calls in the same agent runtime.

Keep context attached to the work

Threads carry transcript history, channel bindings, provider resume tokens, and a fixed workspace_dir.

Use provider CLIs directly

Garyx spawns Claude Code, Codex, and Gemini through their local CLIs, so each provider keeps its normal auth model.

Expose tools through MCP

Every provider run receives a scoped Garyx MCP server and any upstream MCP servers configured in garyx.json.

Turn conversations into operations

Tasks, scheduled automations, gateway restart wakeups, logs, and channel bindings all use the same thread model.

Extend without patching core

Install subprocess channel plugins, update them independently, and keep built-in channels in the main binary.

Runtime boundaries

Local-first, not sandboxed

Provider CLIs run with the gateway process permissions. A workspace path is an execution context, not an isolation boundary.

Secrets stay out of examples

Use environment variables such as TELEGRAM_BOT_TOKEN and placeholders such as /path/to/repo. Do not publish real chat ids, bot ids, tokens, or personal paths.

Gateway API, not gateway web UI

The managed gateway serves APIs, WebSockets, MCP, and health endpoints. The public website is this docs site; the interactive client is the macOS app.

Documentation map

Installation Install the CLI, initialize config, run the managed gateway, and verify a first thread.

Your first bot Wire up Telegram, Feishu / Lark, or WeChat and bind the account to an agent.

Threads & workspaces Understand thread identity, endpoint bindings, immutable workspace directories, and provider sessions.

Channels See how built-in and plugin channels share account config and endpoint binding behavior.

Providers Authenticate Claude Code, Codex, and Gemini, then let Garyx auto-detect them.

MCP integration Use Garyx MCP tools and merge in upstream MCP servers for every provider run.

Configuration Full garyx.json reference for gateway, channels, providers, agents, plugins, automations, and desktop behavior.

CLI commands Every supported command group, organized by workflow.

Security Secret handling, log redaction, local runtime boundaries, and public contribution hygiene.

<style> .garyx-grid, .garyx-callouts, .docs-map { display: grid; grid-template-columns: repeat(auto-fit, minmax(260px, 1fr)); gap: 16px; margin-top: 16px; } .garyx-panel, .garyx-callouts > div, .docs-map > p { border: 1px solid var(--vp-c-divider); border-radius: 8px; padding: 16px; background: var(--vp-c-bg-soft); } .garyx-panel strong, .garyx-callouts strong { display: block; margin-bottom: 8px; } .garyx-panel p, .garyx-callouts p, .docs-map p { margin: 0; } .docs-map > p > a:first-child { display: block; font-weight: 600; margin-bottom: 6px; color: var(--vp-c-brand-1); text-decoration: none; } .docs-map > p > a:first-child + br { display: none; } </style>