快速开始

系统要求

macOS：arm64 / x64
Windows：x64
Linux：x64（AppImage）
从源码运行需要 Node ≥ 22.13 与 pnpm

下载安装包

到 GitHub Releases 下载对应产物：

平台	产物
macOS	`.dmg` / `.zip`（arm64 与 x64）
Windows	NSIS 安装包（x64）
Linux	`.AppImage`（x64）

早期构建可能未签名。macOS Gatekeeper 或 Windows SmartScreen 首次打开时可能提示拦截——若你信任该下载，可在系统设置中允许。

三步开始

安装并打开 OkBot（单实例：再次启动会聚焦已有窗口）。
在设置 → 模型接入添加供应商与 API Key，选一个默认模型（自备供应商）。
创建助手（名称、头像、人设），开始聊天。多数工具默认无需确认即可执行；若你把工具设为询问（或命中强制确认 / MCP 调用），可单次允许、记住规则，或拒绝。

可选下一步：设置 → 客户端 → 网关列表连接远程个人网关；设置 → 电脑连接登记远程执行机；打开应用内市场安装入门助手；需要常开时用 okbot serve（见服务网关）。

数据目录：当前网关主机上的 ~/.okbot/（自定义实例见 okbot serve --data-dir）。

从源码运行

git clone https://github.com/shuzheng/okbot.git
cd okbot
pnpm install
pnpm approve-builds --all   # 若 pnpm 11 提示忽略了构建脚本
pnpm dev

无界面网关：先构建 gateway，再 okbot serve（多实例需成对 --port 与 --data-dir）。详见仓库 README / GUIDE.md 与服务网关。

自托管网关（Docker / Kubernetes）

桌面端仍用原生安装包。若要用 Docker 或 Kubernetes（Helm）跑无界面网关（okbot serve），见产品仓库 docs/install-docker-k8s.md。相关文件在 deploy/docker/ 与 deploy/helm/okbot/。镜像不含 Electron；用桌面客户端附着该远程网关即可。详见服务网关。