第 1 课
一条命令安装并部署首个 Agent
按官方 Quick start 一条命令安装,打开 127.0.0.1:6796,写入模型密钥并部署第一个 Agent。
课程目录第 1 / 2 课
学习位置仅保存在当前浏览器,有效期 180 天。
一条命令安装并部署首个 Agent
一条命令安装并部署首个 Agent
本课按 Xiryn 官方 README「Quick start」整理,目标是:在本机装好依赖与 Docker 工作站镜像,打开
http://127.0.0.1:6796,写入至少一个模型密钥,并部署你的第一个 Agent。
主要来源:xiryn.com · GitHub README Quick start · 本地 UI 端口 6796
你将得到什么
- 本机可访问的 Xiryn 界面:
http://127.0.0.1:6796 .env/ Settings 里至少一条可用的模型 API Key(或本地 Ollama)- 一个已创建、可发消息的 Agent(带独立 Docker 桌面能力,若 Docker 正常)
课前准备
- 电脑约有 4 GB 空闲磁盘(官方 README)。
- 至少一个模型提供商的 API Key(OpenAI / Anthropic / Google / xAI / Groq / Mistral / DeepSeek / OpenRouter 等),或本机已装 Ollama / LM Studio。
- 能接受安装 Git、Node.js(≥20.9)、Docker(setup 脚本可代装)。
- 本课不需要注册 Xiryn 云账号——产品无账户、无遥测(README Security)。
一、Xiryn 是什么(30 秒)
Xiryn 是跑在你自己电脑上的开源个人 Agent:
- 每个 Agent 在 Docker 里的 Linux 桌面工作(Shell + Chromium),不移动你的鼠标、不读你的本机文件。
- 对话、记忆、密钥默认在本机一个 SQLite 文件里。
- 模型用你自己的 Key(BYOK);可选 Firecrawl 做网页检索。
官方对照(README):与 Muse / Grok Bot / Dots 等托管个人 Agent 类似能力,但源码 MIT、数据不出盘(除非你配置的模型/Firecrawl/Telegram 出站)。
二、动手:一条命令安装
macOS / Linux
在终端执行(官方原文,可直接抄):
curl -fsSL https://raw.githubusercontent.com/SouravBeraAkaSpeed/xiryn/main/setup.sh | bash
Windows(PowerShell)
irm https://raw.githubusercontent.com/SouravBeraAkaSpeed/xiryn/main/setup.ps1 | iex
若仓库已 clone,可在仓库根目录跑 ./setup.sh(Windows 可用 setup.cmd)。
Setup 会依次:
- 安装缺失的 Git、Node.js、Docker(macOS 常经 Homebrew;Linux 用 get.docker.com;Windows 可能经 winget 装 Docker Desktop)。
- Clone 到
./xiryn并npm install。 - 启动 Docker,构建 Agent 桌面镜像(首次可能数分钟)。
- 创建
.env并启动服务,默认地址 **http://127.0.0.1:6796**。
首次使用 Docker Desktop 可能要求接受条款;Windows 若提示开启 WSL2 并重启,按提示完成后再跑一次 setup(已完成的步骤会跳过)。
对照结果(成功时你会看到):
- 终端无持续报错退出;提示已在
127.0.0.1:6796启动(或让你随后npm run dev)。 - 浏览器打开 http://127.0.0.1:6796 能看到 Xiryn 界面(非连接拒绝)。
- 本机存在
xiryn目录(默认在执行命令时的当前目录下)。
更想手动装?
官方备选(README「Prefer to do it by hand」):
git clone https://github.com/SouravBeraAkaSpeed/xiryn.git
cd xiryn
npm install
npm run setup # 检查 Docker、构建桌面镜像、创建 .env
npm run dev
用编程 Agent 代装
若你已在用 Claude Code / Codex / Cursor,可把官方「Install and start Xiryn for me…」整段 prompt(见 README「Set up with your coding agent」)贴给它;环境变量示例:
# 无交互、先不启动(再由 Agent 配密钥后启动)
curl -fsSL https://raw.githubusercontent.com/SouravBeraAkaSpeed/xiryn/main/setup.sh | XIRYN_YES=1 XIRYN_NO_START=1 bash
三、写入模型密钥
任选其一(官方):
A. 应用内 Settings(推荐)
打开界面 → Settings → 粘贴对应提供商的 Key。界面只显示掩码值。
B. .env 文件(仓库根目录):
OPENAI_API_KEY=sk-... # 或其他提供商变量名,见 .env.example
# ANTHROPIC_API_KEY=...
# GOOGLE_GENERATIVE_AI_API_KEY=...
# OLLAMA_BASE_URL=http://127.0.0.1:11434
FIRECRAWL_API_KEY=fc-... # 可选:网页搜索与阅读
改 .env 后若服务已在跑,按 README:在 Settings 保存的值优先生效;必要时重启:
cd xiryn
npm run dev
对照结果:
- Settings 里对应提供商显示 Ready / 已保存(掩码)。
- 创建 Agent 时模型列表里能选到该提供商下的模型(或本地模型名)。
占位符请换成你自己的 Key;不要把真实 Key 贴进截图或公开仓库。
四、日常启动与首个 Agent
以后每次:
cd xiryn
npm run dev
# 或:npm run build && npm start
# 或整容器:docker compose up -d
浏览器打开 **http://127.0.0.1:6796**。
建议步骤:
- 点状态栏 alerts 一次,允许桌面通知(Agent 完成/失败/需要你时会响铃)。
- 新建 / Deploy 一个 Agent:起名(如
Atlas)、选模型、可选模板或职责说明。 - 发一条小任务,例如:「用一句话介绍你能做什么,并列出当前工作站是否已就绪。」
对照结果:
- 聊天有流式回复;若 Docker 正常,可在 Machine / 桌面预览里看到独立 Linux 桌面(1280×800,官方描述)。
- Agent 不会移动你本机光标(FAQ:一切发生在容器内)。
- 若未装 Docker:仍可聊天与记忆,但官方说明无法跑代码/桌面——界面会提示缺什么。
五、更新(可选)
cd xiryn
git pull
./setup.sh # Windows: setup.cmd
npm run dev
数据目录(如 data/xiryn.db、Vault、Agent home)更新时不会被清掉(README)。
本课小结
| 步骤 | 命令/动作 | 成功信号 |
|---|---|---|
| 安装 | setup.sh / setup.ps1 | 6796 可打开 |
| 密钥 | Settings 或 .env | 模型可选 |
| 启动 | npm run dev | 界面 + 通知权限 |
| 首 Agent | Deploy + 发短任务 | 有回复;可选见桌面 |
下一课:用 Telegram 在手机上遥控同一批 Agent(官方 docs/telegram.md)。
来源
- https://xiryn.com/
- https://github.com/SouravBeraAkaSpeed/xiryn (README · Quick start / FAQ / Security)
