Workspace templates


If you’re hacking on aura itself, run from source:

如果您正在开发 aura 本身，请从源码运行：


macOS app


You are documenting provider auth or deployment environments

你正在记录提供商认证或部署环境的相关文档


and optional


WhatsApp (QR login)


Scan via WhatsApp → Settings → Linked Devices.

通过 WhatsApp → 设置 → 已关联设备 进行扫描。


For Tailnet access, run

如需 Tailnet 访问，请运行


Mattermost (plugin)


Nodes


Where aura loads environment variables and the precedence order

aura 加载环境变量的位置及优先级顺序


does


(dotenv default; does not override).

（dotenv 默认行为；不覆盖已有值）。


MIT — Free as a lobster in the ocean 💕

MIT —— 像海洋中的龙虾一样自由 💕


Windows (WSL2)


syntax:


— Uses Baileys for WhatsApp Web protocol


Windows (PowerShell):


Install sanity (Node/npm/PATH):


WhatsApp group messages


Nodes (iOS/Android)


0) Prereqs


Troubleshooting


Workspace default (or existing workspace)

默认工作区（或现有工作区）


您正在记录 提供商 的认证或部署环境


Full workspace layout + backup guide:

完整工作区布局 + 备份指南：


If you


— Anthropic (Claude Pro/Max) + OpenAI (ChatGPT/Codex) via OAuth

— Anthropic（Claude Pro/Max）+ OpenAI（ChatGPT/Codex）通过 OAuth


Optional login-shell import

可选的登录 shell 导入


Node ≥ 22


(API keys + OAuth).


See [Configuration: Env var substitution](/gateway/configuration#env-var-substitution-in-config) for full details.


Models overview


What you’ll set:


Providers and UX:


If the config file is missing entirely, step 4 is skipped; shell import still runs if enabled.

如果配置文件完全缺失，则跳过第 4 步；如果已启用，shell 导入仍会运行。


Nacho Iacovino


Help


你正在编写提供商认证或部署环境的文档


In a new terminal, send a test message:

在新终端中，发送一条测试消息：


Env var substitution in config

配置中的 环境变量 替换


Env var substitution in config


(what the Gateway process already has from the parent shell/daemon).

（Gateway 进程从父 shell/守护进程继承的已有环境变量）。


(applied only if


Mattermost Bot (plugin)


Environment variables


Precedence (highest → lowest)


: connect to the Gateway WebSocket (LAN/tailnet/SSH as needed); legacy TCP bridge is deprecated/removed.

：通过 WebSocket 连接到 Gateway（根据需要使用局域网/Tailnet/SSH）；旧版 TCP 桥接已弃用/移除。


), a single long-running process that owns channel connections and the WebSocket control plane.

进行，它是一个长期运行的单进程，负责管理渠道连接和 WebSocket 控制面。


Troubleshooting:


WebChat


Gmail hooks (Pub/Sub)


You are debugging missing API keys in the Gateway

你正在调试 Gateway 中缺失的 API 密钥


) — Blogwatcher skill


(aka


Related


Full reset (also removes workspace)

完全重置（同时移除工作区）


and


(token is required for non-loopback binds).

（非回环绑定时必须提供令牌）。


Synthetic


Discord Bot


Process environment


to update the gateway service entrypoint.

以更新 Gateway 服务入口点。


Clawd


in


The wizard now generates a gateway token by default (even for loopback).

向导现在默认会生成一个 Gateway 令牌（即使在回环模式下也是如此）。


向导 现在默认会生成一个网关令牌（即使是回环连接也是如此）。


Config lives at


syntax:


Summary + next steps, including iOS/Android/macOS apps for extra features.

摘要 + 后续步骤，包括 iOS/Android/macOS 应用以获取额外功能。


— Local imsg CLI integration (macOS)


Remote mode configures a local client to connect to a Gateway elsewhere.

远程模式配置本地客户端以连接到其他位置的 Gateway。


Gateway troubleshooting


: browser flow; paste the


Environment variables


Android app


If you want the deeper reference pages, jump to:

如果您需要更详细的参考页面，请跳转至：


Remote access


Switching between npm and git installs later is easy: install the other flavor and run

之后在 npm 安装和 git 安装之间切换很简单：安装另一种方式并运行


If the Gateway is running on the same computer, that link opens the browser Control UI
immediately. If it fails, start the Gateway first:

如果 Gateway 运行在同一台计算机上，该链接会立即打开浏览器控制界面。如果打开失败，请先启动 Gateway：


Maxim Vovshin


aura = CLAW + TARDIS


Configuration (optional)


Model/auth (OpenAI Code (Codex) subscription OAuth, Anthropic API key (recommended) or setup-token (paste), plus MiniMax/GLM/Moonshot/AI Gateway options)

模型/认证（OpenAI Code (Codex) 订阅 OAuth、Anthropic API 密钥（推荐）或 setup-token（粘贴），以及 MiniMax/GLM/Moonshot/AI Gateway 选项）


FAQ: env vars and .env loading

常见问题：环境变量和 `.env` 加载


Channel allowlists (Slack/Discord/Matrix/Microsoft Teams) when you opt in during the prompts (names resolve to IDs when possible).


aura assistant setup


Example:


Tailscale


Features (high level)


Gateway configuration


to the gateway host.


Send a test message (requires a running Gateway):

发送测试消息（需要 Gateway 正在运行）：


Web surfaces (Control UI)

Web 界面（控制界面）


Gateway issues:


— Bot token + WebSocket events


WebChat + macOS app

网页聊天 + macOS 应用


Ops and safety:


aura = CLAW + TARDIS


: SSH tunnel or tailnet/VPN; see


Wizard


Multiple gateways


Typical fields in


Nodes


expected


Discord Bot


Help


; does not override).


(dotenv default; does not override).

（dotenv 默认行为；不会覆盖）。


Docs


before continuing.


Sandboxing note:


Peter Steinberger


Telegram Bot


Android app


Discord


on any machine, then paste the token (you can name it; blank = default).

在任意机器上执行，然后粘贴令牌（可以命名；留空 = 默认）。


syntax:


Notes:


发送测试消息（需要正在运行的 Gateway）：


Where aura loads environment variables and the precedence order

其中 aura 加载 环境变量 及优先级顺序


— Pi (RPC mode) with tool streaming

— Pi（RPC 模式），支持工具流式传输


Config lives at


) — Creator, lobster whisperer

）— 创始人，龙虾低语者


recommended


keys:


Getting Started


Dashboard (local loopback):


iMessage


if present.


never override existing values


. Plugins add Mattermost (Bot API + WebSocket) and more.
aura also powers the aura assistant.

。插件还支持 Mattermost（Bot API + WebSocket）等更多平台。
aura 还为 aura 助手提供支持。


and


not recommended


The dashboard is the browser Control UI for chat, config, nodes, sessions, and more.
Local default: http://127.0.0.1:18789/
Remote access:

仪表板是用于聊天、配置、节点、会话 等功能的浏览器控制界面。
本地默认地址：http://127.0.0.1:18789/
远程访问：


Env var substitution in config


仪表盘是用于聊天、配置、节点、会话等功能的浏览器控制界面。
本地默认地址：http://127.0.0.1:18789/
远程访问：


(or pass


Maxim Vovshin


FAQ (concepts)


Docs hubs (all pages linked)

文档中心（所有页面链接）


Start here:


New install from zero:


do nothing


or


If you don’t have a global install yet, run the onboarding step via

如果您还没有全局安装，请通过以下方式运行 上手引导 步骤


macOS app


Troubleshooting:


: it is the only process allowed to own the WhatsApp Web session. If you need a rescue bot or strict isolation, run multiple gateways with isolated profiles and ports; see

：它是唯一允许持有 WhatsApp Web 会话的进程。如果需要备用机器人或严格隔离，可使用独立配置文件和端口运行多个 Gateway；请参阅


runs your login shell and imports only

运行你的登录 shell 并仅导入


iOS app


and chat in the browser, or open

然后在浏览器中聊天，或打开


in


Discord


Gateway logging


Logs:


Multiple gateways


Webhooks


Configuration: Env var substitution


You need to know which env vars are loaded, and in what order

你需要了解加载了哪些环境变量，以及它们的加载顺序


— Route provider accounts/peers to isolated agents (workspace + per-agent sessions)

— 将提供商账户/对等方路由到隔离的智能体（工作区 + 每智能体会话）


Workspace location + bootstrap files

工作区位置 + 引导文件


Telegram


— because every space lobster needs a time-and-space machine.

— 因为每只太空龙虾都需要一台时空机器。


4) Pair + connect your first chat surface

4）配对 + 连接您的第一个聊天界面


—— 因为每只太空龙虾都需要一台时空机器。


Gateway configuration


Mario Zechner


"We're all just playing with our own prompts."

"我们都只是在玩弄自己的提示词。"


Node (recommended; required for WhatsApp/Telegram). Bun is


Logging


— The space lobster who demanded a better name

—— 那只要求更好名字的太空龙虾


and


Gateway issues:


) — Pi creator, security pen-tester

）— Pi 创始人，安全渗透测试员


Windows (WSL2)


runs your login shell and imports only **missing** expected keys:

运行你的登录 shell 并仅导入**缺失的**预期键：


Help hub: common fixes, install sanity, and where to look when something breaks

帮助中心：常见修复方法、安装完整性检查，以及出现问题时的排查指南


Environment variables


: HTTP file server on

：HTTP 文件服务器运行在


Anthropic API key (recommended)


— an AI, probably high on tokens

—— 一个可能被令牌冲昏头脑的 AI


(aka


Security


(@nachoiacovino,


— Pairs as a node and exposes Canvas + Chat + Camera

—— 作为节点配对并暴露 Canvas + 聊天 + 相机


Docs


Remote access (SSH tunnel / Tailscale Serve):


Discovery


Moonshot example:


Gateway token


Doctor


to route inbound messages (the wizard can do this).

以路由入站消息（向导可以执行此操作）。


— A space lobster, probably

—— 大概是一只太空龙虾说的


Group Chat Support


Linux app


here:


CLI onboarding wizard


You can reference env vars directly in config string values using

你可以在配置的字符串值中直接使用以下方式引用环境变量


Where aura loads environment variables and the precedence order

aura 加载环境变量的位置及优先级顺序


at


Off


even for loopback so local WS clients must authenticate.

即使在回环地址上也使用，以确保本地 WS 客户端必须进行认证。


override).


CLI onboarding wizard: guided setup for gateway, workspace, channels, and skills

CLI 上手引导向导：Gateway、工作区、渠道和技能的引导式设置


Skills


If you want a quick “get unstuck” flow, start here:

如果你想快速"解决卡住的问题"，从这里开始：


How it works


Telegram


Seeds the workspace files needed for the agent bootstrap ritual.

生成智能体引导启动仪式所需的工作区文件。


1) Install the CLI (recommended)

1）安装 CLI（推荐）


to your config.


Related


: connect to the Gateway WebSocket (LAN/tailnet/SSH as needed); legacy TCP bridge is deprecated/removed.

：连接到 Gateway WebSocket（根据需要使用局域网/Tailnet/SSH）；旧版 TCP 桥接已弃用/移除。


Control UI (browser)


common fixes + troubleshooting


You want the fastest path from install → onboarding → first message

您希望找到从安装 → 上手引导 → 发送第一条消息的最快路径


Start here


Repairs:


Remote access


Gateway auth


Local gateway (loopback)

本地 Gateway（回环地址）


Multi-instance quickstart (optional):

多实例快速入门（可选）：


Shell env import


Security


Environment variables

aura pulls environment variables from multiple sources. The rule is

环境变量

aura 从多个来源获取环境变量。规则是


block


(plugin): bot token + base URL.

（插件）：机器人令牌 + 基础 URL。


Dashboard


(what the Gateway process already has from the parent shell/daemon).

（Gateway 进程从父 shell/守护进程中已获取的内容）。


FAQ: env vars and .env loading

常见问题：环境变量和 `.env` 加载


Multiple gateways


Node ≥ 22


Group Chat Support


uses


Stores it under


Signal setup (signal-cli)


— Local imsg CLI integration (macOS)


Repairs:


iOS node


If you’re looking for conceptual questions (not “something broke”):

如果你在寻找概念性问题（而非"出了故障"）：


Gateway troubleshooting


（Gateway 进程从父 shell/守护进程中已继承的值）。


Windows (WSL2)


Tailscale


Precedence (highest → lowest)


Node


Canvas host


Troubleshooting:


Web surfaces


You are debugging missing API keys in the Gateway

你正在调试 Gateway 中缺失的 API 密钥


Process environment


OAuth credentials live in


config


— an AI, probably high on tokens

— 一个可能被令牌冲昏头脑的 AI


(@Hyaxia,


(defaults) vs


Shell env


Credits


If the config file is missing entirely, step 4 is skipped; shell import still runs if enabled.

如果配置文件完全缺失，步骤 4 将被跳过；如果已启用，shell 导入仍会运行。


Models overview


What it sets:


Workspace templates


Reset uses


: no auth configured yet.


 on the gateway host.
Docs:

 （在 Gateway 主机上）。
文档：


WebChat


Subscription auth


in the current working directory


Port, bind, auth mode, tailscale exposure.

端口、绑定、认证模式、Tailscale 暴露。


Runtime selection:


Related


— An AI, probably high on tokens

—— 一个可能被令牌冲昏头脑的 AI


— Pairs as a node and exposes a Canvas surface

—— 作为节点配对并暴露 Canvas 界面


Moonshot (Kimi K2)


WhatsApp group messages


Gateway configuration


Configuration examples


Env var substitution in config

You can reference env vars directly in config string values using

配置中的环境变量替换

你可以使用以下方式在配置字符串值中直接引用环境变量


Sessions


(default


7) Verify end-to-end


See


Android node


(with sane defaults) as quickly as possible.

（使用合理的默认配置）尽可能快地完成。


macOS menu bar app + voice wake:

macOS 菜单栏应用 + 语音唤醒：


Onboarding


Voice notes


) — Blogwatcher skill


Onboarding Wizard (CLI)

上手引导向导 (CLI)


(never


Setup


— 作为节点配对并提供 Canvas 界面


Keep / Modify / Reset

保留 / 修改 / 重置


你正在调试 Gateway 中缺失的 API 密钥


) for scripts.


Something broke and you want the fastest path to a fix

出了问题，你想找到最快的修复方法


(bun not recommended).


You’re new and want the “what do I click/run” guide

你是新手，想要一份"该点什么/该运行什么"的操作指南


From source (development):


Start here


exposes every step (mode, workspace, gateway, channels, daemon, skills).

展示每个步骤（模式、工作区、Gateway、渠道、守护进程、技能）。


not


New install from zero:


Related


WhatsApp Integration


Agent bridge


and


), a single long-running process that owns channel connections and the WebSocket control plane.

），一个拥有 渠道 连接和 WebSocket 控制平面的单一长期运行进程。


for node WebViews; see

用于节点 WebView；参见


3) Start the Gateway


Gateway


Process environment


Gemini example:


Brave Search API key for web search. Easiest path:

Brave Search API 密钥用于网络搜索。最简单的方式：


Auth: where it lives (important)


），一个拥有 渠道 连接和 WebSocket 控制平面的单一长期运行进程。


— DMs + groups via grammY

— 通过 grammY 支持私信和群组


OpenAI Code (Codex) subscription (OAuth)


Hetzner


(default); groups are isolated


) asks the running gateway for a health snapshot.

）向运行中的 Gateway 请求健康快照。


Two equivalent ways to set inline env vars (both are non-overriding):

两种等效的内联环境变量设置方式（均为非覆盖模式）：


Gateway runbook


Logging


http://127.0.0.1:18789/ (or http://localhost:18789/)


broke”):


The name


Docs hubs (all pages linked)

文档中心（所有页面链接）


Logs:


Streaming + chunking


@steipete


(default


Disable auth only if you fully trust every local process.

仅在您完全信任每个本地进程时才禁用认证。


Goal: go from


CLI path + DB access.

CLI 路径 + 数据库访问。


Slash commands


Web surfaces (Control UI)

Web 界面（控制界面）


Env var equivalents:


你是新手，想要一份"我该点击/运行什么"的指南


出了问题，你想要最快的修复方法


(mode, bind, auth, tailscale)

（模式、绑定、认证、Tailscale）


Nix mode


Web tools


If you want a quick “get unstuck” flow, start here:

如果你想要一个快速的"解决卡点"流程，从这里开始：


Install sanity (Node/npm/PATH):


: optional QR login.


Media: audio


Config


) — Blogwatcher skill


keeps the defaults:


Env var substitution in config

配置中的 环境变量 替换


Install


iOS node


(configurable).


Recommended:


Shell env import


Start here


Skills:


: config is auto-written.


Workspace templates


两种等效的内联环境变量设置方式（均为非覆盖式）：


— An AI, probably high on tokens

— 大概是一个嗑多了 token 的 AI 说的


If you’re looking for conceptual questions (not “something broke”):

如果你在寻找概念性问题的答案（而不是"出了什么问题"）：


Ops and safety:


If you want to lock it down, start with

如果你想进行锁定配置，请从以下内容开始


Gateway troubleshooting


Env var equivalents:


Logs:


: optional


Token


Config reference:


Runtime requirement:


(token is required for non-loopback binds).

（非回环绑定需要令牌）。


两种等效的方式来设置内联环境变量（两者都是非覆盖的）：


: if


Precedence (highest → lowest)


and (for groups) mention rules.

以及（针对群组的）提及规则。


optional background service


Most operations flow through the


Install


Agent bridge


: local


— Mention-based by default; owner can toggle

— 默认基于提及触发；所有者可切换


Vercel AI Gateway


Optional login-shell import

可选的登录 shell 导入


exists, choose


Wizard attempts to enable lingering via


: stores the key for you.


: HTTP file server on

：HTTP 文件服务器位于


Beginner guide: from zero to first message (wizard, auth, channels, pairing)

新手指南：从零开始到发送第一条消息（向导、认证、渠道、配对）


Install sanity (Node/npm/PATH):


) — Pi creator, security pen-tester

）— Pi 创作者，安全渗透测试员


—— 默认基于提及触发；所有者可以切换


never override existing values


— Bot token + WebSocket events


Updating / rollback


如果你想快速"解决卡住的问题"，从这里开始：


: prompts for


出了问题，你想找到最快的修复方法


Pi


and


(or


missing


If you installed the service during onboarding, the Gateway should already be running:

如果您在上手引导过程中安装了服务，Gateway 应该已经在运行：


Wizard


Telegram Bot


Tailscale


两种等效的内联 环境变量 设置方式（均不会覆盖）：


from the repo.


Open the dashboard (local Gateway):

打开仪表板（本地 Gateway）：


and chat in the browser. Docs:

然后在浏览器中对话。文档：


遇到故障了，你想找到最快的修复方法


Next steps (optional, but great)

后续步骤（可选，但强烈推荐）


Multi-agent routing


(aka


如果你想要一个快速的"快速排障"流程，请从这里开始：


Doctor


If a token is configured, paste it into the Control UI settings (stored as

如果配置了令牌，请将其粘贴到控制界面设置中（存储为


Where aura loads environment variables and the precedence order

aura 加载环境变量的位置及优先级顺序


If you want to lock it down, start with

如果你想锁定访问权限，请从以下内容开始


OpenCode Zen example:


FAQ (concepts)


WhatsApp


Gateway configuration


@badlogicc


), applied only for missing expected


); it tries without sudo first.

）；它会先尝试不使用 sudo。


Vercel AI Gateway (multi-model proxy)


— DMs + groups via grammY

— 通过 grammY 支持私聊和群组


If the config is invalid or contains legacy keys, the wizard stops and asks
     you to run

如果配置无效或包含遗留键，向导会停止并要求您运行


: connect to the Gateway WebSocket (LAN/tailnet/SSH as needed); legacy TCP bridge is deprecated/removed.

：连接到 Gateway WebSocket（根据需要使用 LAN/tailnet/SSH）；旧版 TCP 桥接已弃用/移除。


Discord:


Downloads the appropriate release asset.


Discord


MiniMax M2.1


Discovery


Vercel AI Gateway example:


Dashboard (browser Control UI)

仪表板（浏览器控制界面）


Core Contributors


You need to know which env vars are loaded, and in what order

你需要了解哪些环境变量会被加载，以及它们的加载顺序


Note: legacy Claude/Codex/Gemini/Opencode paths have been removed; Pi is the only coding-agent path.

注意：旧版 Claude/Codex/Gemini/Opencode 路径已被移除；Pi 是唯一的编程 智能体 路径。


（非回环绑定需要令牌）。


Repairs:


aura pulls environment variables from multiple sources. The rule is

aura 从多个来源获取环境变量。规则是


Wizard doc:


missing


aura pulls environment variables from multiple sources. The rule is **never override existing values**.

aura 从多个来源拉取环境变量。规则是**永远不覆盖已有的值**。


Gateway logging


Runtime requirement:


Telegram + WhatsApp DMs default to


shows “no auth configured”, go back to the wizard and set OAuth/key auth — the agent won’t be able to respond without it.

显示"未配置认证"，请返回向导设置 OAuth/密钥认证——智能体在没有认证的情况下将无法响应。


http://127.0.0.1:18789/ (or http://localhost:18789/)


 is the best pasteable, read-only debug report.
Health probes:

 是最佳的可粘贴只读调试报告。
健康探针：


for full


Anthropic OAuth (Claude Code CLI)


walks you through:


) — Location parsing (Telegram + WhatsApp)


Features (high level)


Help hub: common fixes, install sanity, and where to look when something breaks

帮助中心：常见修复方法、安装完整性检查，以及出现问题时的排查方向


MIT — Free as a lobster in the ocean 💕

MIT — 像海洋中的龙虾一样自由 💕


Mattermost


, aura uses the bundled Pi binary in RPC mode with per-sender sessions.

，aura 将使用内置的 Pi 二进制文件以 RPC 模式运行，并采用按发送者区分的会话。


Telegram:


Help


if present or prompts for a key, then saves it for daemon use.

（如果存在）或提示输入密钥，然后保存供守护进程使用。


aura bridges WhatsApp (via WhatsApp Web / Baileys), Telegram (Bot API / grammY), Discord (Bot API / channels.discord.js), and iMessage (imsg CLI) to coding agents like

aura 将 WhatsApp（通过 WhatsApp Web / Baileys）、Telegram（Bot API / grammY）、Discord（Bot API / channels.discord.js）和 iMessage（imsg CLI）桥接至编程智能体，例如


Env var


(dotenv default; does not override).

（dotenv 默认行为；不覆盖）。


Setting up a new machine


Remote access


from the repo.


(dotenv default; does not

（dotenv 默认；不会


Wizard


: Gateway WS defaults to


Docs hubs (all pages linked)

文档中心（所有页面链接）


To add more isolated agents (separate workspace + sessions + auth), use:

要添加更多隔离的智能体（独立的工作区 + 会话 + 认证），请使用：


wipe anything unless you explicitly choose

不会删除任何内容，除非您明确选择


Gateway logging


. Plugins add Mattermost (Bot API + WebSocket) and more.
aura also powers the aura assistant.

。插件可添加 Mattermost（Bot API + WebSocket）等更多渠道支持。
aura 同时也驱动着 aura 助手。


Nodes


Env var equivalents:


Recommended: set up a Brave Search API key so the agent can use

推荐：设置 Brave Search API 密钥，以便智能体可以使用


For Tailnet access, run

如需 Tailnet 访问，请运行


If


Model/Auth


Recommended Anthropic path:


Precedence (highest → lowest)


Config `env` block


"EXFOLIATE! EXFOLIATE!"


帮助中心：常见修复方法、安装健全性检查，以及出问题时该去哪里排查


WhatsApp


: it is the only process allowed to own the WhatsApp Web session. If you need a rescue bot or strict isolation, run multiple gateways with isolated profiles and ports; see

：它是唯一允许拥有 WhatsApp Web 会话 的进程。如果需要救援机器人或严格隔离，请使用隔离的配置文件和端口运行多个网关；参见


Guided setup (recommended):


FAQ: env vars and .env loading

常见问题：环境变量 和 .env 加载


. Docs:


Two equivalent ways to set inline env vars (both are non-overriding):

两种等效的内联环境变量设置方式（两者都不会覆盖）：


OAuth credentials (legacy import):

OAuth 凭据（旧版导入）：


Cron jobs


Dashboard (browser Control UI)

仪表盘（浏览器控制界面）


Remote use


expected keys:


in


Manual run (foreground):


Gateway port


runs your login shell and imports only

运行你的登录 shell，并仅导入


。插件可添加 Mattermost（Bot API + WebSocket）等更多平台。
aura 还为 aura 助手提供支持。


Config


aura 💕


), serving


Lets you choose a node manager:

让您选择一个 Node 管理器：


One Gateway per host (recommended)

每台主机一个 Gateway（推荐）


If the config file is missing entirely, step 4 is skipped; shell import still runs if enabled.

如果配置文件完全缺失，则跳过第 4 步；如果已启用，shell 导入仍会运行。


Voice notes


Configuration: Env var substitution


Mattermost


Z.AI example:


Logs:


Pairing (DM + nodes)


(auto-installs UI deps).

（自动安装 UI 依赖项）。


You can reference env vars directly in config string values using `${VAR_NAME}` syntax:

你可以使用 `${VAR_NAME}` 语法在配置字符串值中直接引用环境变量：


writes


Gmail hooks (Pub/Sub)


If you want a quick “get unstuck” flow, start here:

如果你想快速了解"快速排障"流程，请从这里开始：


common fixes + troubleshooting


Config `env` block


Clawd


Gateway settings (port/bind/auth/tailscale)


— Direct chats collapse into shared

— 直接聊天合并到共享的


Related docs


QuickStart vs Advanced


.
Sessions are stored under


Multi-agent routing


Writes


@steipete


aura pulls environment variables from multiple sources. The rule is

aura 从多个来源获取环境变量。规则是


Environment variables


runs your login shell and imports only

运行你的登录 shell 并仅导入


(@nachoiacovino,


Agent workspace


Windows (WSL2)


Environment variables

Could you please provide the file path or the full text about "Environment variables" that you'd like me to translate?


Env var substitution in


Default posture: unknown DMs get a short code and messages are not processed until approved.
If your first DM gets no reply, approve the pairing:

默认策略：未知私信会收到一个短码，消息在批准之前不会被处理。
如果您的第一条私信没有收到回复，请批准配对：


Local vs Remote


如果配置文件完全缺失，则跳过第 4 步；如果已启用，shell 导入仍会运行。


The wizard now generates a gateway token by default (even for loopback).

向导 现在默认会生成网关令牌（即使是回环连接）。


Doctor


Tailscale exposure


If you’re looking for conceptual questions (not “something broke”):

如果你在寻找概念性问题的解答（而不是"出了问题"）：


Configuration: Env var substitution


(applied only if missing).


Pick a default model from detected options (or enter provider/model manually).

从检测到的选项中选择默认模型（或手动输入提供商/模型）。


The dashboard is the browser Control UI for chat, config, nodes, sessions, and more.
Local default: http://127.0.0.1:18789/
Remote access:


Remote mode


You need to know which env vars are loaded, and in what order

你需要了解加载了哪些环境变量，以及加载的顺序


See


Telegram Bot


non-overriding):


syntax:


Nodes


Start here


; auth profiles live in


Fastest chat: open the Control UI (no channel setup needed). Run

最快聊天方式：打开控制界面（无需设置渠道）。运行


If you’re looking for conceptual questions (not “something

如果你在寻找概念性问题（不是"出了什么


Switching between npm and git installs later is easy: install the other flavor and run

之后在 npm 和 git 安装之间切换很简单：安装另一种方式然后运行


imply non-interactive mode. Use

意味着非交互模式。请使用


If the Gateway is loopback‑only, use SSH tunneling or a tailnet.

如果 Gateway 仅绑定回环地址，请使用 SSH 隧道或 tailnet。


Config


Webhooks


Optional login-shell import

可选的登录 shell 导入


"We're all just playing with our own prompts."

"我们都只是在玩弄自己的提示词罢了。"


Gateway runbook


— Direct chats collapse into shared


Gateway (from this repo):

Gateway（从此仓库）：


and


and (for groups) mention rules.

以及（针对群组的）提及规则。


@steipete


Gateway issues:


Gateway configuration


Pairing (DM + nodes)


never override existing values


Env var equivalents:


License


in the current working directory


Something broke and you want the fastest path to a fix

出了问题，你想找到最快的修复方法


(dotenv default; does not override).

（dotenv 默认行为；不会覆盖）。


Process environment


aura 从多个来源获取 环境变量。规则是


allowlist


Optional login-shell import

可选的登录 shell 导入


— Direct chats collapse into shared

—— 直接聊天折叠为共享的


) — Location parsing (Telegram + WhatsApp)


如果你在寻找概念性问题的解答（而不是"出了问题"）：


Synthetic (Anthropic-compatible)


Canvas host


Media: audio


Note: legacy Claude/Codex/Gemini/Opencode paths have been removed; Pi is the only coding-agent path.

注意：旧版 Claude/Codex/Gemini/Opencode 路径已移除；Pi 是唯一的编程智能体路径。


(auto‑generated, even on loopback)

（自动生成，即使在回环地址上也是如此）


Related


Group Chat Support


Headless/server tip: do OAuth on a normal machine first, then copy

无头/服务器提示：先在普通机器上完成 OAuth，然后复制


block


你需要了解加载了哪些环境变量，以及加载的顺序


Install


Logs:


— Pairs as a node and exposes a Canvas surface

— 作为节点配对并提供 Canvas 界面


iMessage


 block

Two equivalent ways to set inline env vars (both are non-overriding):

 块

设置内联环境变量的两种等效方式（均为非覆盖式）：


Where aura loads environment variables and the precedence order

其中 aura 加载 环境变量 及优先级顺序


If the config file is missing entirely, step 4 is skipped; shell import still runs if enabled.

如果配置文件完全缺失，则跳过第 4 步；如果启用了 shell 导入，它仍会运行。


for node WebViews; see

用于节点 WebView；请参阅


Fastest first chat: open the Control UI (no channel setup needed). Run

最快的首次对话方式：打开 Control UI（无需设置渠道）。运行


— The space lobster who demanded a better name

— 那只要求取个更好名字的太空龙虾


Mario Zechner


Daemon install (LaunchAgent / systemd user unit)


Cron jobs


— Route provider accounts/peers to isolated agents (workspace + per-agent sessions)

—— 将 提供商 账户/对等方路由到隔离的 智能体（工作区 + 按 智能体 的 会话）


from GitHub releases:

（从 GitHub 发布版本）：


http://127.0.0.1:18789/ (or http://localhost:18789/)


Telegram / Discord / others


Default


如果配置文件完全缺失，则跳过第 4 步；如果已启用，shell 导入仍会运行。


Web surfaces


Configuration


You’re new and want the “what do I click/run” guide

你是新手，想要一份"我该点什么/运行什么"的指南


Media Support


Install


Config + credentials + sessions

配置 + 凭据 + 会话


You are debugging missing API keys in the Gateway

你正在调试 Gateway 中缺失的 API 密钥


Help


RPC adapters


Skills


Media: images


Remote use


If you’re looking for conceptual questions (not “something broke”):

如果你在寻找概念性问题（不是"出了故障"）：


to update the gateway service entrypoint.


How it works


Something broke and you want the fastest path to a fix

出了问题，你想找到最快的修复方法


You are documenting provider auth or deployment environments

你正在编写提供商认证或部署环境的文档


in the current working directory


aura 💕


Gateway


— Bot token + WebSocket events


model/auth (OAuth recommended)

模型/认证（推荐使用 OAuth）


— Send and receive images, audio, documents

—— 发送和接收图片、音频、文档


Install sanity (Node/npm/PATH):


Some channels are delivered as plugins. When you pick one during onboarding, the wizard
will prompt to install it (npm or a local path) before it can be configured.

部分渠道以插件形式提供。当您在上手引导期间选择某个渠道时，向导会提示先安装它（通过 npm 或本地路径），然后才能进行配置。


Slash commands


— DMs + guild channels via channels.discord.js


(what the Gateway process already has from the parent shell/daemon).

（Gateway 进程从父 shell/守护进程继承的已有环境变量）。


One Gateway per host (recommended)

每台主机一个 Gateway（推荐）


Two equivalent ways to set inline env vars (both are

两种等效的内联环境变量设置方式（两者都是


Global


and


: run


Voice notes


Env var substitution in config


Quick start


so the Gateway stays up after logout.

启用驻留，以便在注销后 Gateway 保持运行。


(@Hyaxia,


Config lives at


; does not override).


: on macOS the wizard checks Keychain item "Claude Code-credentials" (choose "Always Allow" so launchd starts don't block); on Linux/Windows it reuses

：在 macOS 上，向导会检查钥匙串项 "Claude Code-credentials"（请选择"始终允许"以避免 launchd 启动时被阻止）；在 Linux/Windows 上，它会复用


pairing defaults (secure DMs)

配对默认设置（安全私信）


Open the dashboard (local Gateway):

打开仪表盘（本地 Gateway）：


— 那只要求取个更好名字的太空龙虾


Troubleshooting


— A space lobster, probably

—— 大概是一只太空龙虾说的


— 发送和接收图片、音频、文档


Gmail hooks (Pub/Sub)


Media: audio


Alternative (global install):


: it is the only process allowed to own the WhatsApp Web session. If you need a rescue bot or strict isolation, run multiple gateways with isolated profiles and ports; see

：它是唯一被允许拥有 WhatsApp Web 会话 的进程。如果您需要救援机器人或严格隔离，请使用隔离的配置文件和端口运行多个网关；参见


Dashboard


Models overview


macOS: LaunchAgent


 Bun has known issues with these
channels. If you use WhatsApp or Telegram, run the Gateway with

Bun 在这些渠道上存在已知问题。如果您使用 WhatsApp 或 Telegram，请使用


DM security: default is pairing. First DM sends a code; approve via

私信安全：默认为配对模式。首次私信会发送一个验证码；通过


(applied only if missing).


(dotenv default; does not override).

（dotenv 默认行为；不会覆盖）。


Global


Media Support


: Node (recommended; required for WhatsApp/Telegram). Bun is


The Gateway exposes the wizard flow over RPC (


Getting Started


Android node


macOS app onboarding:

macOS 应用上手引导：


5) DM safety (pairing approvals)

5）私信安全（配对审批）


Configuration: Env var substitution


Token if the remote Gateway requires auth (recommended)

如果远程 Gateway 需要认证，则需提供令牌（推荐）


 to create a separate agent with its own workspace,
sessions, and auth profiles. Running without

创建一个拥有独立工作区、会话和认证配置的单独智能体。不使用


Help hub: common fixes, install sanity, and where to look when something breaks

帮助中心：常见修复方法、安装完整性检查，以及出问题时该去哪里排查


Anthropic token (paste setup-token)


Config


shell/daemon).

shell/守护进程中获得的内容）。


Control UI


Subscription auth


Daemon install


(aka


Slash commands


Control UI (browser)


for a machine‑readable summary.


Gateway troubleshooting


Java 21


Remote use


(@Hyaxia,


Environment variables


Gateway issues:


Media: images


which stores


enabled.

启用，shell 导入仍会运行。


at


OpenAI Code (Codex) subscription (Codex CLI)


Primary entrypoint:


You can reference env vars directly in config string values using

您可以使用以下方式在配置字符串值中直接引用 环境变量


Providers


RPC adapters


Top-level overview of aura, features, and purpose

aura 的顶层概述、功能和用途


aura bridges WhatsApp (via WhatsApp Web / Baileys), Telegram (Bot API / grammY), Discord (Bot API / channels.discord.js), and iMessage (imsg CLI) to coding agents like

aura 将 WhatsApp（通过 WhatsApp Web / Baileys）、Telegram（Bot API / grammY）、Discord（Bot API / 渠道.discord.js）和 iMessage（imsg CLI）桥接到编程 智能体，例如


If you


Peter Steinberger


Env var equivalents:


Configuration


npm / pnpm


install or change anything on the remote host.

在远程主机上安装或更改任何内容。


Install


Skip


: background install (launchd/systemd; WSL2 uses systemd)


at


Daemon


never override existing values


Introducing aura to newcomers


Requires a logged-in user session; for headless, use a custom LaunchDaemon (not shipped).

需要已登录的用户会话；对于无头模式，请使用自定义 LaunchDaemon（未随附）。


so launchd can read it.

以便 launchd 可以读取。


Gateway configuration


Install sanity (Node/npm/PATH):


— an AI, probably high on tokens

— 大概是一个嗑多了 token 的 AI 说的


No remote installs or daemon changes are performed.

不会执行远程安装或守护进程更改。


WebChat


Where aura loads environment variables and the precedence order

aura 加载环境变量的位置及优先级顺序


Tip:


Sets


(applied only if missing).


Pairing (DM + nodes)


Re-running the wizard does


FAQ (concepts)


Troubleshooting:


aura pulls environment variables from multiple sources. The rule is

aura 从多个来源获取环境变量。规则是


Doctor


If you’re looking for conceptual questions (not “something broke”):

如果你在寻找概念性问题（而不是"出了问题"）：


New install from zero:


The wizard can write tokens/config for you. If you prefer manual config, start with:

向导可以为您写入令牌/配置。如果您更喜欢手动配置，请从以下内容开始：


aura = CLAW + TARDIS


Telegram


Start here


Ops and safety:


See [Configuration: Env var substitution](/gateway/configuration#env-var-substitution-in-config) for full details.


: OpenAI Code (Codex) subscription (OAuth) or API keys. For Anthropic we recommend an API key;

：OpenAI Code (Codex) 订阅（OAuth）或 API 密钥。对于 Anthropic，我们推荐使用 API 密钥；


Env var equivalents:


aura pulls environment variables from multiple sources. The rule is **never override existing values**.

aura 从多个来源拉取环境变量。规则是**永远不覆盖已有的值**。


Flow details (local)


If the Control UI assets are missing, the wizard attempts to build them; fallback is

如果 Control UI 资源文件缺失，向导会尝试构建它们；后备方案是


Logs:


at


From source (development):


Providers:


import


install + account config.


Reset


launches the wizard.


Help hub: common fixes, install sanity, and where to look when something breaks

帮助中心：常见修复方法、安装完整性检查，以及出现问题时的排查方向


) and offers scopes:


Quick start


channels (WhatsApp/Telegram/Discord/Mattermost (plugin)/...)


Configuration examples


workspace bootstrap + skills


: Gateway WS defaults to


and


Logging


common fixes + troubleshooting

常见修复方案 + 故障排除


Install sanity (Node/npm/PATH):


Most operations flow through the


(default


Environment


Providers and UX:


Troubleshooting:


Mattermost Bot (plugin)


Advanced


Shell env import


If you


Nodes (iOS/Android)


Telegram


Help


details.


or


FAQ: env vars and .env loading

常见问题：环境变量与 `.env` 加载


Groups


(Ubuntu recommended). WSL2 is strongly recommended; native Windows is untested, more problematic, and has poorer tool compatibility. Install WSL2 first, then run the Linux steps inside WSL. See

（推荐 Ubuntu）。强烈推荐使用 WSL2；原生 Windows 未经测试，问题较多，且工具兼容性较差。请先安装 WSL2，然后在 WSL 内执行 Linux 步骤。参见


Mario Zechner


Repairs:


Guided setup (recommended):


block


macOS remote


See


).
  See


Mattermost Bot (plugin)


What the wizard does


The wizard starts with


Gateway troubleshooting


iOS app


iMessage


— Pairs as a node and exposes Canvas + Chat + Camera

— 作为节点配对并提供 Canvas + 聊天 + 相机


Optional login-shell import

可选的登录 shell 导入


Gateway


First time setup from zero


Discovery hints:


— Pi (RPC mode) with tool streaming

—— Pi（RPC 模式），支持 工具 流式传输


Loopback-first


— Anthropic (Claude Pro/Max) + OpenAI (ChatGPT/Codex) via OAuth

— 通过 OAuth 支持 Anthropic（Claude Pro/Max）+ OpenAI（ChatGPT/Codex）


You can reference env vars directly in config string values using

你可以使用以下方式在配置的字符串值中直接引用环境变量


(or


Finish


missing


Gateway configuration


See


Google Chat


Discord


(default); groups are isolated


帮助中心：常见修复方法、安装完整性检查，以及出现问题时的排查方向


: the wizard generates one by default (even on loopback) and stores it in

：向导默认会生成一个（即使在回环地址上）并将其存储在


You are documenting provider auth or deployment environments

你正在编写提供商认证或部署环境的文档


(if Minimax chosen)

（如果选择了 Minimax）


您可以使用以下方式在配置字符串值中直接引用 环境变量


— Mention-based by default; owner can toggle

— 默认基于提及；所有者可切换


Security


if present or prompts for a key, then saves it to

（如果存在）或提示输入密钥，然后保存到


gateway


 way to set up aura on macOS,
Linux, or Windows (via WSL2; strongly recommended).
It configures a local Gateway or a remote Gateway connection, plus channels, skills,
and workspace defaults in one guided flow.

在 macOS、Linux 或 Windows（通过 WSL2；强烈推荐）上设置 aura 的方式。它通过一个引导式流程配置本地 Gateway 或远程 Gateway 连接，以及渠道、技能和工作区默认设置。


Help


Something broke and you want the fastest path to a fix

出了问题，你想要最快的修复方法


zero


and


in


Skills (recommended)


— Optional transcription hook


missing).


Where aura loads environment variables and the precedence order

aura 加载环境变量的位置及优先级顺序


FAQ (concepts)


variables


Configuration (optional)


from the repo.


Shell env import


How it works


Doctor


Providers (Telegram, WhatsApp, Discord, Google Chat, Mattermost (plugin), Signal)


— DMs + guild channels via channels.discord.js


(applied only if missing).


Two equivalent ways to set inline env vars (both are non-overriding):

设置内联环境变量的两种等效方式（均为不覆盖模式）：


your first DM returns a pairing code. Approve it (see next step) or the bot won’t respond.

您的第一条私信会返回一个配对码。请批准它（参见下一步），否则机器人将不会响应。


at


API key


Most operations flow through the


Signal


— Optional transcription hook


License


(default


Telegram DM tip:


Repairs:


) — Creator, lobster whisperer

）— 创作者，龙虾低语者


Configuration


FAQ: env vars and .env loading

常见问题：环境变量和 .env 加载


Wizard


macOS app


"EXFOLIATE! EXFOLIATE!"


Gateway logging


Help


Network model


More detail:


MiniMax


Webhooks


in the current working directory


Introducing aura to newcomers


If


never override existing values


). It sets up:


(and


Shell env import


Media Support


WhatsApp group messages


exe.dev


; does not override).


Switching between npm and git installs later is easy: install the other flavor and run

之后在 npm 和 git 安装之间切换很简单：安装另一种方式并运行


Starts the Gateway (if needed) and runs

启动 Gateway（如需）并运行


Global


Providers and UX:


WhatsApp Integration


Groups


first working chat


; does not


Nodes (iOS/Android)


Install


Maxim Vovshin


in the current working directory


syntax:


(optional; recommended if you build from source)

（可选；如果从源码构建则推荐安装）


Pairing


Core Contributors


WhatsApp credentials go under


or


Nix mode


Synthetic example:


From source (development)


missing


You can reference env vars directly in config string values using `${VAR_NAME}` syntax:

你可以在配置字符串值中使用 `${VAR_NAME}` 语法直接引用环境变量：


Runtime requirement:


Existing config detection


Gateway troubleshooting


Multi-instance quickstart (optional):

多实例快速开始（可选）：


iOS app


Groups


— Pairs as a node and exposes Canvas + Chat + Camera

— 作为节点配对并提供 Canvas + 聊天 + 相机


You are debugging missing API keys in the Gateway

您正在调试 Gateway 中缺失的 API 密钥


Config


Follow‑up reconfiguration:


Precedence (highest → lowest)


Telegram


(default); groups are isolated


Gateway issues:


您正在调试 Gateway 中缺失的 API 密钥


Help hub: common fixes, install sanity, and where to look when something breaks

帮助中心：常见修复方法、安装健全性检查，以及出问题时该去哪里排查


FAQ (concepts)


Health check


Kimi Coding


Always-on / VPN setups:

常驻运行 / VPN 设置：


Canvas host


Streaming + chunking


Web surfaces


Multi-agent routing


Mattermost (plugin)


Start here


Shell env import


From source (development):


to


You need to know which env vars are loaded, and in what order

您需要了解加载了哪些 环境变量，以及加载顺序


Core Contributors


Remote access


),
so group/channel sessions are sandboxed. If you want the main agent to always
run on host, set an explicit per-agent override:

），因此群组/渠道会话是沙箱化的。如果您希望主智能体始终在主机上运行，请设置显式的逐智能体覆盖：


Gateway logging


Security


Credits


WebChat + macOS app


Global


Sessions


: SSH tunnel or tailnet/VPN; see


) — Location parsing (Telegram + WhatsApp)


You’re new and want the “what do I click/run” guide

你是新手，想要一份"该点击什么/运行什么"的指南


Multi-instance quickstart (optional):

多实例快速开始（可选）：


), serving


Pi


你是新手，想要一份"该点什么/该运行什么"的指南


You are documenting provider auth or deployment environments

您正在记录 提供商 的认证或部署环境


你是新手，想要一份"我该点击/运行什么"的指南


Loopback-first


iOS node


aura assistant setup


Pairing doc:


Non-interactive flags:


The name


Linux (and Windows via WSL2): systemd user unit


Related


macOS app


or use allowlists.


Help


两种等效的内联设置 环境变量 的方式（均为非覆盖）：


: SSH tunnel or tailnet/VPN; see


Streaming + chunking


; does not override).


Wizard runs a model check and warns if the configured model is unknown or missing auth.

向导会运行模型检查，如果配置的模型未知或缺少认证则发出警告。


Media: images


runs your login shell and imports only

运行你的登录 shell，并仅导入


Gateway configuration


aura pulls environment variables from multiple sources. The rule is

aura 从多个来源拉取 环境变量。规则是


Runtime


).
Clients (macOS app, Control UI) can render steps without re‑implementing onboarding logic.

）。客户端（macOS 应用、Control UI）可以渲染步骤而无需重新实现上手引导逻辑。


Models overview


in the current working directory


(full control).


One Gateway per host (recommended)

每台主机一个 Gateway（推荐）


adds gateway health probes to status output (requires a reachable gateway).

将 Gateway 健康探测添加到状态输出中（需要可达的 Gateway）。


when model is unset or


— Anthropic (Claude Pro/Max) + OpenAI (ChatGPT/Codex) via OAuth

—— 通过 OAuth 支持 Anthropic（Claude Pro/Max）+ OpenAI（ChatGPT/Codex）


Reads the available skills and checks requirements.

读取可用技能并检查依赖条件。


Dashboard (browser Control UI)

仪表板（浏览器控制界面）


Related


Configuration examples


@badlogicc


Precedence (highest → lowest)


Getting Started


do nothing


at


Clawd


Control UI (browser)


Nacho Iacovino


Android app


You can reference env vars directly in config string values using

你可以使用以下方式在配置字符串值中直接引用环境变量


iOS/Android nodes (Canvas/camera/voice):


: bot token.


block


Add


(@nachoiacovino,


Local mode (default)


lowest)


Tailscale


Auth


Env var substitution in config


Skills


你需要了解加载了哪些环境变量，以及它们的加载顺序


Something broke and you want the fastest path to a fix

出了问题，你想找到最快的修复方法


runs your login shell and imports only

运行您的登录 shell 并仅导入


— because every space lobster needs a time-and-space machine.

— 因为每只太空龙虾都需要一台时空机器。


Env var equivalents:


) — Creator, lobster whisperer

）—— 创建者，龙虾低语者


Non‑interactive mode


Global


(stores


Gateway configuration


(you’ll be prompted for your phone number)

（系统会提示您输入手机号码）


FAQ (concepts)


You are debugging missing API keys in the Gateway

你正在调试 Gateway 中缺失的 API 密钥


aura 从多个来源获取环境变量。规则是


set an API key (wizard can store it for service use).

设置 API 密钥（向导可以将其存储以供服务使用）。


Mattermost (plugin)


, get it at


gateway settings


or


Web surfaces (Control UI)

Web 界面（控制界面）


See


Auth profiles (OAuth + API keys):

认证配置文件（OAuth + API 密钥）：


Windows uses WSL2; signal-cli install follows the Linux flow inside WSL.

Windows 使用 WSL2；signal-cli 安装遵循 WSL 内的 Linux 流程。


Models overview


Doctor


Installer options (install method, non-interactive, from GitHub):

安装选项（安装方式、非交互式、从 GitHub 安装）：


(aka


JVM builds require


Shell env import


Updating / rollback


Node ≥ 22


Pi


Installs optional dependencies (some use Homebrew on macOS).

安装可选依赖项（部分在 macOS 上使用 Homebrew）。


missing


Top-level overview of aura, features, and purpose

aura 的顶层概述、功能和用途


: Gateway WS defaults to


: WhatsApp QR login, Telegram/Discord bot tokens, Mattermost plugin tokens, etc.

：WhatsApp 二维码登录、Telegram/Discord 机器人令牌、Mattermost 插件令牌等。


Web tools


FAQ: env vars and .env loading

常见问题：环境变量 和 .env 加载


3.5) Quick verify (2 min)

3.5）快速验证（2 分钟）


Discord Bot


Linux app


— Local UI + menu bar companion for ops and voice wake

— 本地界面 + 菜单栏辅助工具，用于操作和语音唤醒


WhatsApp Integration


You are documenting provider auth or deployment environments

你正在记录提供商认证或部署环境


(what the Gateway process already has from the parent

（Gateway 进程已从父级


If the config file is missing entirely, step 4 is skipped; shell import still runs if enabled.

如果配置文件完全缺失，则跳过步骤 4；如果已启用，shell 导入仍会运行。


Sessions


Start here:


(what the Gateway process already has from the parent shell/daemon).

（Gateway 进程已从父 shell/守护进程继承的值）。


equivalents:


If the Gateway is running on the same computer, that link opens the browser Control UI
immediately. If it fails, start the Gateway first:

如果 Gateway 运行在同一台计算机上，该链接会立即打开浏览器控制界面。如果无法打开，请先启动 Gateway：


Remote Gateway URL (


Start here


— Optional transcription hook


Nacho Iacovino


WebChat + macOS app

网页聊天 + macOS 应用


Peter Steinberger


Running or configuring the onboarding wizard


to update the gateway service entrypoint.


What you’ll choose:


— DMs + groups via grammY

—— 通过 grammY 支持私聊和群组


Open the dashboard (local Gateway):

打开仪表板（本地 Gateway）：


macOS: if you plan to build the apps, install Xcode / CLT. For the CLI + gateway only, Node is enough.
Windows: use

macOS：如果您计划构建应用程序，请安装 Xcode / CLT。如果仅使用 CLI + Gateway，Node 就足够了。
Windows：使用


— DMs + guild channels via channels.discord.js

—— 通过 渠道.discord.js 支持私聊和服务器 渠道


Process environment


or


for node WebViews; see

用于节点 WebView；参见


exists, the wizard can reuse it.


Default workspaces follow


: uses


Use


"EXFOLIATE! EXFOLIATE!"


Features (high level)


See


aura bridges WhatsApp (via WhatsApp Web / Baileys), Telegram (Bot API / grammY), Discord (Bot API / channels.discord.js), and iMessage (imsg CLI) to coding agents like

aura 将 WhatsApp（通过 WhatsApp Web / Baileys）、Telegram（Bot API / grammY）、Discord（Bot API / channels.discord.js）和 iMessage（imsg CLI）桥接到编程 智能体，例如


also bundles A2UI assets; if you need to run just that step, use

也会打包 A2UI 资源；如果您只需要运行该步骤，请使用


Where aura loads environment variables and the precedence order

aura 加载环境变量的位置及优先级顺序


Send a test message (requires a running Gateway):

发送测试消息（需要运行中的 Gateway）：


keys.


— Local imsg CLI integration (macOS)


block


2) Run the onboarding wizard (and install the service)

2）运行上手引导向导（并安装服务）


— An AI, probably high on tokens

— 一个可能被令牌冲昏头脑的 AI


aura assistant setup


Help hub: common fixes, install sanity, and where to look when something breaks

帮助中心：常见修复方法、安装完整性检查，以及出现问题时的排查指南


; does not override).


runs your login shell and imports only

运行您的登录 shell 并仅导入


QuickStart


Top-level overview of aura, features, and purpose

aura 的顶层概述、功能特性与用途


Add agent (non‑interactive) example:

添加智能体（非交互）示例：


Quick start


, aura uses the bundled Pi binary in RPC mode with per-sender sessions.

，aura 将使用捆绑的 Pi 二进制文件以 RPC 模式运行，并使用每个发送者的 会话。


The name


to automate or script onboarding:

用于自动化或脚本化上手引导：


Env var substitution in config


runs your login shell and imports only

运行你的登录 shell 并仅导入


Help


— Uses Baileys for WhatsApp Web protocol


The wizard can install


Models overview


"We're all just playing with our own prompts."

"我们都只是在玩弄自己的提示词。"


— Send and receive images, audio, documents

— 收发图片、音频、文档


Repairs:


RPC adapters


from the repo.


Logging


Loopback-first


in


Config only


Troubleshooting


Gateway issues:


Configuration: Env var substitution


Nix mode


Non‑loopback binds still require auth.


Recommended path: use the


Global


Mattermost (plugin):


You’re new and want the “what do I click/run” guide

你是新手，想要一份"我该点击/运行什么"的指南


，aura 将使用内置的 Pi 二进制文件以 RPC 模式运行，并为每个发送者提供 会话。


Tip:


Native builds are used when available.

如有原生构建则优先使用。


Start here:


Start here


If the config file is missing entirely, step 4 is skipped; shell import still runs if

如果配置文件完全缺失，则跳过第 4 步；如果


Gateway logging


works without a key). Easiest path:

无需密钥也可使用）。最简单的方式：


Agent bridge


Moonshot AI (Kimi + Kimi Coding)


— Route provider accounts/peers to isolated agents (workspace + per-agent sessions)

— 将 提供商 账户/对等方路由到隔离的 智能体（工作区 + 每个 智能体 的 会话）


Config


missing


You need to know which env vars are loaded, and in what order

你需要了解加载了哪些环境变量，以及它们的加载顺序


do nothing


not recommended


If you’re looking for conceptual questions (not “something broke”):

如果你在寻找概念性问题（不是"某个东西坏了"）：


(applied only if missing).


Gateway


You are debugging missing API keys in the Gateway

你正在调试 Gateway 中缺失的 API 密钥


: service account JSON + webhook audience.


Linux: Avahi (


You are documenting provider auth or deployment environments

你正在记录提供商认证或部署环境的文档


Android node


Auth recommendation: keep


— A space lobster, probably

— 大概是一只太空龙虾说的


iMessage


Start here


: HTTP file server on

：HTTP 文件服务器位于


Precedence (highest →


Configuration: Env var substitution


Skills


Updating / rollback


Logging


Docs


— Local UI + menu bar companion for ops and voice wake

— 本地界面 + 菜单栏辅助工具，支持操作和语音唤醒


Troubleshooting:


Guided setup (recommended):


WhatsApp doc:


For Tailnet access, run

如需 Tailnet 访问，请运行


macOS: Bonjour (


你是新手，想要一份"我该点击/运行什么"的指南


block


Add another agent


) — Pi creator, security pen-tester

）—— Pi 创建者，安全渗透测试员


If you want to lock it down, start with

如果您想进行锁定配置，请从以下内容开始


See


What the wizard writes


You can reference env vars directly in config string values using

你可以在配置的字符串值中直接引用环境变量，使用


@badlogicc


never override existing values


Cron jobs


in


If you want a quick “get unstuck” flow, start here:

如果你想快速排障，请从这里开始：


Channels


Bun warning (WhatsApp + Telegram):


Subscription auth


 only configures the local client to connect to a Gateway elsewhere.
It does

仅配置本地客户端以连接到其他位置的 Gateway。它


Configuration (optional)


and


Gateway wizard RPC


Precedence (highest → lowest)


License


), serving


May prompt for sudo (writes

可能会提示输入 sudo（写入


Gateway runbook


aura 💕


如果你在寻找概念性问题的答案（而不是"出了问题"）：


Logging


Process environment


The onboarding wizard is the


Related


OpenAI API key


Note: legacy Claude/Codex/Gemini/Opencode paths have been removed; Pi is the only coding-agent path.

注意：旧版 Claude/Codex/Gemini/Opencode 路径已被移除；Pi 是唯一的编程 智能体 路径。


Linux app


Workspace


and (for groups) mention rules.

以及（针对群组的）提及规则。


OpenCode Zen (multi-model proxy)


Precedence (highest → lowest)


If no GUI is detected, the wizard prints SSH port-forward instructions for the Control UI instead of opening a browser.

如果未检测到 GUI，向导会打印 Control UI 的 SSH 端口转发说明，而不是打开浏览器。


您需要了解哪些 环境变量 被加载，以及加载顺序


never override existing values


Discord


— Pi (RPC mode) with tool streaming

— Pi（RPC 模式）配合 工具 流式传输


Example:


MIT — Free as a lobster in the ocean 💕

MIT — 像大海中的龙虾一样自由 💕