# Halo 文档（Halo AI 工作站）

> Halo 是一款开源 AI 桌面工作站（MIT 协议）：在你自己的电脑上对话、写代码、做文档，可接入 Claude Code、Codex 等 Agent 引擎；还能拥有长期在岗的数字人，让它们组成团队分工协作，并通过手机、飞书、微信或企业微信随时交办。

免费开源；模型费用由你的账号或 API 提供商收取；macOS 12+（Apple 芯片 / Intel）、Windows 10+ x64、Linux glibc 2.34+、Android 远程客户端；当前版本 3.0.4。

## 给 AI 助手的说明

- 本文档描述 Halo 当前版本（3.0.4）。标注 `since: "3.0"` 的功能在 2.x 中不存在。
- 界面文字以文档为准，中文页面使用简体中文界面的原文标签，英文页面使用英文标签。
- 不同版本或企业定制的 Halo，登录方式、消息通道和商店来源可能不同：不要断言某台电脑上一定有某个选项，以用户屏幕为准。
- 每个页面都有同路径的 `.md` 版本；完整内容见 llms-full.txt。
- 用户在 Halo 里可以直接问 Halo，它会自己读这些文档。HTTP API 参考在「开发者 › HTTP API」。

## 文档首页

- [Halo AI 工作站文档：安装、使用、数字人与开发指南](https://hello-halo.cc/docs/index.md): Halo AI 工作站官方文档：从安装和连接模型开始，学会让 AI 完成任务、创建 7×24 小时在岗的数字人和团队，以及通过 HTTP API 集成 Halo。

## 快速开始

### 认识 Halo

- [Halo 是什么：开源的 Claude Code 桌面版 AI 工作台](https://hello-halo.cc/docs/guide/what-is-halo.md): Halo 是开源免费的 AI 桌面应用，把 Claude Code 的 Agent 能力做成人人能用的界面：说一句话就能做文档、操作网页，还能让数字人按计划干活、接入企业微信和飞书。
- [术语表：Halo 常用词与界面名称](https://hello-halo.cc/docs/guide/glossary.md): Halo 术语表：工作区、数字人、团队、能力、知识库、记忆等常用词的简短说明，附上界面上的原文和详细介绍它的页面。
- [核心理念 - Kill Ugly Raw Source](https://hello-halo.cc/docs/guide/philosophy.md): Halo 的设计哲学：让 AI 重写一切丑陋的原始代码，用最前沿的 AI 能力服务每一个人；也讲 Halo 是怎么诞生的，以及它是怎样由 AI 开发出来的。

### 快速开始

- [快速开始：安装 Halo 并完成第一个任务](https://hello-halo.cc/docs/getting-started/index.md): 从零开始用 Halo：安装应用，连接一个 AI 模型，用一句话完成第一个任务，再花两分钟认识界面。每一步都写明你会看到什么，以及卡住时怎么办。
- [安装 Halo：macOS、Windows、Linux 下载与系统要求](https://hello-halo.cc/docs/getting-started/install.md): 下载并安装 Halo，处理第一次打开时的系统提示；Windows 会多一步安装命令执行环境。看到「让我们开始设置」，就说明 Halo 装好了。
- [配置 AI 模型：登录账号或填写 API Key](https://hello-halo.cc/docs/getting-started/setup-ai.md): Halo 要连上一个 AI 模型才能干活。先用表格选一种方式：免费登录、已有会员账号、API Key，或者暂时跳过，再按对应的步骤完成。
- [获取 API Key：DeepSeek、Kimi、智谱等平台怎么申请](https://hello-halo.cc/docs/getting-started/api-keys.md): 到模型平台注册、充值或领取额度，创建一个 API Key，再回到 Halo 选对提供商粘贴进去。这里列出各平台的控制台入口，以及在 Halo 里要选的名字。
- [第一次对话：用 Halo 完成第一个任务](https://hello-halo.cc/docs/getting-started/first-chat.md): 在 Halo 工作区用一句话交代任务，看着 Halo 动手做出一份真实的文件；顺便学会补充要求、停下来，以及回答它的提问。
- [认识 Halo 界面：左侧栏、会话页、任务面板与设置](https://hello-halo.cc/docs/getting-started/app-tour.md): 一页看懂 Halo 3.0 的界面：左侧栏六个入口各管什么，会话页的四个区域，输入框里的按钮，右上角的更多菜单、任务面板、搜索和设置。

### 换个工具过来

- [从 Claude Code 迁移到 Halo：概念对照与配置沿用](https://hello-halo.cc/docs/guide/from-claude-code.md): 已经在用 Claude Code 或 Codex？这里对照两边的概念，说明怎样用已有的订阅登录、把仓库作为工作区打开、沿用 CLAUDE.md、技能和 MCP，以及和终端里不一样的地方。

## 使用指南

### 日常使用

- [使用指南：Halo 各项功能怎么用](https://hello-halo.cc/docs/features/index.md): Halo 使用指南总览：按日常使用、让 AI 动手、开发者常用、随时随地、设置与管理分组，快速找到工作区、会话、AI 浏览器、远程访问等每项功能的说明。
- [工作区（空间）：按项目隔离对话、文件和记忆](https://hello-halo.cc/docs/features/spaces.md): Halo 的工作区（旧版叫“空间”）把一个项目的文件夹、对话、数字人、技能和记忆放在一起，互不干扰。你可以新建、切换、改名、更换文件夹或删除工作区。
- [会话：新建、搜索、中途补充与引用回复](https://hello-halo.cc/docs/features/conversations.md): 在 Halo 里新建、置顶、重命名和删除会话，设置发送键，在 Halo 工作时随时补充或停下，读懂一条回复，并引用回复片段、给会话设定目标。
- [图片输入与文件附件：把图片和文件交给 Halo](https://hello-halo.cc/docs/features/image-input.md): 在 Halo 里用粘贴、拖入或 ＋ 附上图片、文件和文件夹：桌面版直接读取本机文件，网页和安卓端先上传到工作区；模型不支持图片输入时，用本机文字识别读出图中文字。
- [模型与账号：多账号、按会话选模型和深度思考](https://hello-halo.cc/docs/features/models.md): 在 Halo 里管理 AI 模型和账号：同一家并排登录多个账号，接入 API Key 和自定义地址，为每个会话选模型、调深度思考，并查看剩余配额。
- [记忆：让 Halo 记住你的偏好和决定](https://hello-halo.cc/docs/features/memory.md): Halo 的记忆是 AI 为自己记下的长期笔记：同一工作区的对话共享一份记忆，每位数字人也有自己的记忆。你可以设置、整理、查看文件或清除它。
- [任务面板：运行中的工作和等你处理的事](https://hello-halo.cc/docs/features/tasks.md): Halo 的任务面板把所有工作区里正在运行的工作、等你回答的问题和刚完成的结果放在一个列表里，点一下就回到那件事。
- [同时推进多件事：多个对话、工作区和团队并行](https://hello-halo.cc/docs/features/parallel-work.md): 在 Halo 里同时开着几个对话和工作区各做各的事，工作中随时补充要求，在任务面板跟进进度，大活交给团队，固定的活交给数字人。

### 让 AI 动手

- [能力开关：为会话打开网页控制、AI 终端等工具](https://hello-halo.cc/docs/features/capabilities.md): Halo 输入框 ＋ › 能力 里的开关，决定 AI 在这个会话里能用哪些工具：网页控制、团队协作、AI 终端、文字识别和操作 Halo，以及默认值和生效时机。
- [AI 浏览器自动化：让 AI 打开网页、填表和抓取数据](https://hello-halo.cc/docs/features/ai-browser.md): 在 Halo 里打开网页控制，AI 就能用内置浏览器打开网页、点击、填表、下载文件和整理页面数据，并沿用你已登录的网站。
- [AI 终端：和 AI 共用一个真正的终端](https://hello-halo.cc/docs/features/ai-terminal.md): Halo 的 AI 终端是你和 AI 共用的真实终端：你登录 SSH 后交给 AI 继续，跑长任务、操作命令行工具都在同一个会话里。支持 macOS 和 Windows。
- [知识库：让 AI 基于你的文档回答](https://hello-halo.cc/docs/features/knowledge-base.md): 把 PDF、Office 文档、图片和文本放进 Halo 知识库，AI 会先查阅这些文档再回答，并列出来源。学习在本机完成，不消耗 token。
- [Office 文档：用 AI 做 PPT、写 Word、处理 Excel](https://hello-halo.cc/docs/features/office-documents.md): 让 Halo 用内置的文档技能生成和修改 Word、Excel、PowerPoint 和 PDF 文件，不用另装任何软件；文件保存在工作区文件夹里，多数可以直接在画布中预览。
- [文件与画布：在 Halo 里预览、编辑和管理工作区文件](https://hello-halo.cc/docs/features/files-and-canvas.md): 在 Halo 右侧的工作区资源栏里管理文件，在画布中预览和编辑代码、Markdown、表格、图片和 PDF，并看懂新/改标记、快捷键和磁盘变更提示。
- [邮件功能：让数字人收发邮件、管理日历](https://hello-halo.cc/docs/features/email.md): 在 Halo 里配好一个邮箱，数字人就能替你查收、搜索、发送和整理邮件；再填一个 CalDAV 地址，它还能查看和安排日历。
- [会话之间互相协作：读取、提问与转交](https://hello-halo.cc/docs/features/cross-conversation.md): 在 Halo 里，一个会话的 AI 可以读取同一工作区的其他会话，把结论转交过去，或者提问并等对方回复；开启对话协作的数字人也能参与。
- [操作 Halo：让 AI 帮你管理工作区、数字人和设置](https://hello-halo.cc/docs/features/operate-halo.md): 在 Halo 里打开「操作 Halo」能力，AI 就能按你说的话改名对话、新建工作区、暂停数字人、绑定知识库、切换模型。它默认关闭，删除类操作不会弹确认框。

### 开发者常用

- [变更与代码评审：查看 Git 改动、AI 评审并提交](https://hello-halo.cc/docs/features/code-review.md): 在 Halo 的「变更」里查看工作区 Git 仓库的改动和差异，让 AI 做快速评审或团队评审，再暂存、提交并推送。
- [Agent 引擎：切换 Claude Code、Codex 等引擎](https://hello-halo.cc/docs/features/agent-engines.md): Halo 的 Agent 引擎负责驱动 AI 干活：默认用 Claude Code SDK，也可以换成实验性的 Halo SDK、Codex SDK 或 DeepSeek dsh。这里说明怎么切换、各引擎有什么不同。
- [Skills 技能：安装、调用和管理可复用的 AI 技能](https://hello-halo.cc/docs/features/skills.md): Halo 的技能是写给 AI 的可复用工作说明：从商店安装或自己添加，AI 会按需自动选用，你也可以用 /技能名 点名调用；技能可以装到全局或单个工作区，数字人和访客也能用。
- [MCP 服务器：给 Halo 接入外部工具](https://hello-halo.cc/docs/features/mcp.md): 在 Halo 的能力库里接入 MCP 服务器：手动添加或粘贴 JSON 一次导入多个，测试连接、逐个开关工具，并决定哪些工作区和数字人能用。
- [命令与快捷键：斜杠命令、IM 命令和键盘快捷键](https://hello-halo.cc/docs/features/commands.md): Halo 的命令与快捷键：聊天输入框里的 / 菜单，发给数字人机器人的 IM 命令（停止、清空上下文），以及键盘快捷键和发送键。

### 随时随地

- [远程访问：用手机或其他电脑使用 Halo](https://hello-halo.cc/docs/features/remote-access.md): 在 Halo 桌面版打开远程访问，同一网络下用局域网地址、在外面用永久公网地址，输入访问密码，就能在手机或另一台电脑的浏览器里使用这台电脑上的 Halo。
- [在手机上用 Halo：安卓 App 与手机浏览器](https://hello-halo.cc/docs/features/mobile.md): 用 Halo 安卓 App 或手机浏览器连上你电脑上的 Halo，在手机上看进度、发消息、回答数字人的问题；AI 仍在电脑上干活。

### 设置与技巧

- [设置参考：Halo 每个设置项的作用与默认值](https://hello-halo.cc/docs/features/settings.md): Halo 设置页逐项说明：从 AI 模型、消息通道到系统、高级、远程访问和关于，每一项的作用、默认值、取值范围，以及哪些只在桌面版里有。
- [最佳实践：用好 Halo 的工作区、上下文、记忆和模型](https://hello-halo.cc/docs/advanced/best-practices.md): Halo 最佳实践：一个项目一个工作区，一个话题一个会话，管好记忆，按任务选模型和深度思考级别，把重复的活交给数字人，并养成几个安全习惯。

### 场景与对比

- [场景示例：按工作岗位整理的 Halo 用法](https://hello-halo.cc/docs/use-cases/index.md): 按行政、运营、销售、财务、学生和开发整理的 Halo 用法，每条都是可以直接复制给 Halo 的一句话，并链接到详细的使用说明。
- [AI 桌面助手：在你自己的电脑上干活的 AI](https://hello-halo.cc/docs/seo/ai-desktop-agent.md): Halo 是开源的 AI 桌面助手：在你自己的电脑上读写文件、操作浏览器和终端、生成 Word / Excel / PPT，把一件事从头做到尾。
- [AI Agent 自动化：从一句话到定时执行的工作流](https://hello-halo.cc/docs/seo/ai-agent-automation.md): 用 Halo 做 AI Agent 自动化：一句话交代任务，AI 自己拆解步骤、调用浏览器和各种工具完成；需要重复做的事交给数字人定时运行。
- [AI 数字人智能体是什么？和视频数字人、RPA 的区别](https://hello-halo.cc/docs/seo/ai-digital-human.md): Halo 的 AI 数字人是会按计划干活的 AI 智能体，不是做视频的虚拟形象。看它和视频数字人、RPA、聊天机器人有什么不同，以及由哪些部分组成。
- [AI 数字员工：按计划在岗、会汇报的 AI 同事](https://hello-halo.cc/docs/seo/ai-digital-worker.md): 用 Halo 创建 AI 数字员工：说清楚要做的事和节奏，它按计划自动工作，把结果发到企业微信、飞书或邮件，需要你决定时会先来问你。
- [AI 牛马是什么：把重复琐碎的工作交给 AI](https://hello-halo.cc/docs/seo/ai-niuma.md): “AI 牛马”是网上对替人做重复琐碎工作的 AI 的说法。在 Halo 里，这样的 AI 叫数字人：按计划整理数据、汇总信息、写报告，需要决定时再来问你。
- [Claude Code 桌面版：可视化图形界面，也支持 Codex](https://hello-halo.cc/docs/seo/claude-code-desktop.md): Halo 是开源的 Claude Code 图形界面客户端：不用命令行就能用 Claude Code、Codex 等 Agent 引擎，可用账号登录或自定义 API，还能用手机远程交办。

### 管理员与 IT

- [管理员与 IT：Halo 的安全评审、部署与运维](https://hello-halo.cc/docs/advanced/index.md): 给管理员和 IT 的 Halo 入口：安全评审要看的事实，批量部署、模型网关与代理、更新、私有商店、Halo Server，以及日志和诊断。
- [安全与权限控制：Halo 的数据流、凭据和 AI 权限](https://hello-halo.cc/docs/advanced/security.md): Halo 的安全与权限控制说明：哪些数据留在本机、哪些会发出去，密钥怎样存放，AI 和 IM 访客、其他电脑的同事各能做什么，远程访问有什么风险。
- [批量部署 Halo：系统要求、安装包与预配置](https://hello-halo.cc/docs/advanced/deployment.md): 给团队或公司的多台电脑部署 Halo：先核对系统要求和安装包，再了解 Windows 命令执行环境、每位用户第一次打开看到什么，以及哪些设置能提前定好。
- [模型网关与代理：接入公司 API 网关并设置网络代理](https://hello-halo.cc/docs/advanced/gateway-and-proxy.md): 把公司兼容 OpenAI 或 Anthropic 接口的模型网关接成 Halo 的 AI 来源，配置代理和不走代理的地址，并了解没有外网时哪些功能照常可用。
- [部署联邦网关：让不同网络的电脑组成团队](https://hello-halo.cc/docs/advanced/federation-gateway.md): 自建 Halo 联邦网关，让不在同一局域网的电脑也能组成数字人团队：用单个程序或 Docker 部署，配好 HTTPS，再在每台电脑的远程访问设置里填上网关地址。
- [去中心化数字人团队：Raft 风格共识](https://hello-halo.cc/docs/advanced/team-consensus.md): Halo 的数字人团队分布在成员各自的电脑上，没有中心服务器保存团队状态。主持人在成员电脑间轮换，换人不丢数据、看板不分叉。了解设计、取舍和适用规模。
- [更新 Halo：自动更新、手动检查与 Windows 快速更新](https://hello-halo.cc/docs/advanced/updates.md): Halo 会在后台自动检查并下载新版本，准备好后弹出提示，点一下即可完成更新；也可以手动检查，并了解 Windows 快速更新、强制更新和预览频道。
- [私有商店：在 Halo 里添加公司自己的商店来源](https://hello-halo.cc/docs/advanced/private-store.md): 在 Halo 的设置 › 应用商店里管理商店来源：认识 5 个内置来源，添加公司自建的私有源，开关或移除来源，并弄清私有源需要提供哪些文件。
- [配置路径：Halo 的数据、配置、日志和技能放在哪里](https://hello-halo.cc/docs/advanced/config-paths.md): Halo 的配置路径一览：在 macOS、Windows、Linux 上，数据、设置和凭据、日志、技能、Claude 配置目录各放在哪个文件夹，以及怎样从 Halo 里直接打开。
- [换电脑迁移 Halo：搬走数据、账号和数字人](https://hello-halo.cc/docs/advanced/migrate.md): 把 Halo 完整搬到新电脑：拷贝哪两个目录、路径为什么要一致、哪些需要重新登录；只想带走一位数字人时，导出数字人包再导入。

## 数字人

### 数字人

- [AI 数字人：让 AI 按计划和事件自动工作](https://hello-halo.cc/docs/digital-humans/overview.md): Halo 的数字人是长期在岗的 AI 成员：按计划自动干活，在企业微信、飞书、微信里接活，做完向你汇报，拿不准时来问你。这里讲清它和普通会话的区别，以及怎么用起来。
- [创建数字人：一句话、商店或表单三种方式](https://hello-halo.cc/docs/digital-humans/create.md): 在 Halo 里创建一位数字人：最省事的是直接对 Halo 说你要它做什么；也可以从商店装现成的，或者用表单、导入文件自己建。
- [数字人运行计划：定时、工作日与消息触发](https://hello-halo.cc/docs/digital-humans/triggers.md): 设置 Halo 数字人什么时候开始干活：按间隔或按时间定时运行，只在中国大陆工作日运行，收到机器人消息时处理，手动运行，或通过 HTTP 请求触发。
- [能力与设置：数字人每一组设置管什么](https://hello-halo.cc/docs/digital-humans/capabilities.md): Halo 数字人「能力与设置」标签的逐组说明：身份与指令、触发器、运行时参数、模型与能力、工具与资源、消息与通知和高级，每项管什么、默认是什么。
- [管理数字人：运行记录、回答提问、暂停与导出](https://hello-halo.cc/docs/digital-humans/manage.md): 数字人快速上手之后的日常管理：查看 Halo 数字人每次运行做了什么，回答它等你决定的问题，手动运行或暂停，导出给同事或卸载，以及同时能跑几个、失败后会怎样。
- [让数字人一直在线：电脑、开机启动与后台运行](https://hello-halo.cc/docs/digital-humans/keep-running.md): Halo 的数字人运行在你自己的电脑上。这里讲清电脑和 Halo 要怎么设置，数字人才能按时干活：关窗口和退出的区别、开机自动启动、睡眠、通知和手机查看。
- [让数字人提醒你：一次性和重复提醒](https://hello-halo.cc/docs/digital-humans/reminders.md): 在 Halo 数字人的聊天里说一句「明天 9 点提醒我交周报」，到点它会在同一个聊天里提醒你；在企业微信、飞书或微信里设的提醒，会发回那个聊天。
- [数字人商店：安装和更新现成的数字人与技能](https://hello-halo.cc/docs/digital-humans/store.md): 在 Halo 的商店里找别人做好的数字人和技能，填几项配置就能装好开工；也讲怎么更新、MCP 服务在哪里装，以及怎样把自己做的数字人分享出去。
- [生成数字人头像：输入名字，得到和 Halo 里一样的头像](https://hello-halo.cc/docs/digital-humans/avatar.md): Halo 里每位数字人的头像都由它的名字生成。输入数字人的名字，就能在这里得到同一张头像，并下载 PNG 或 SVG，用在聊天平台里的机器人等需要头像图片的地方。

### 团队

- [数字人协作与通信：组团队分工、交接与汇报](https://hello-halo.cc/docs/digital-humans/collaboration.md): 让 Halo 的几位数字人组成团队，分工完成一件大事：一句话组建临时协作，满意了就保留成长期团队，还能请同事电脑上的数字人一起干活。
- [团队工作台：任务、成员、成果与决策](https://hello-halo.cc/docs/digital-humans/team-workbench.md): 打开 Halo 的长期团队，在工作台里给团队派任务、看成员的进展和产出、回答等你决定的事，以及运行、暂停、退出或解散团队。
- [保存团队与定时运行：长期团队、成员与运行计划](https://hello-halo.cc/docs/digital-humans/saved-teams.md): 把临时协作保留下来，或在 Halo 里手动新建长期团队：选成员和负责人、写团队目标，再给团队设运行计划、HTTP 触发和定期检查。
- [跨电脑团队：邀请同事带着数字人加入](https://hello-halo.cc/docs/digital-humans/cross-computer-teams.md): 用邀请链接请同事带着自己的 Halo 数字人加入你的团队：同一网络直接连，跨网络经联邦网关；再设定同事能让你的数字人做什么，以及有人离线时会怎样。

### 消息通道

- [消息通道概览：在企业微信、飞书和微信里用数字人](https://hello-halo.cc/docs/digital-humans/channels.md): 让同事在企业微信、飞书或微信里直接找 Halo 数字人办事，或让数字人把结果主动发出去：双向机器人和单向通知的区别，以及该选哪一种。
- [配置企业微信智能机器人：扫码把数字人接入企业微信](https://hello-halo.cc/docs/digital-humans/wecom-bot.md): 用手机企业微信扫一下，就能接入企业微信 Bot：同事私聊或在群里 @ 机器人，就能找 Halo 数字人办事；已有 Bot ID 和 Secret 时也可以手动接入。
- [企业微信机器人进阶玩法：群聊、命令、文件和主动推送](https://hello-halo.cc/docs/digital-humans/wecom-bot-features.md): 接好企业微信机器人之后的用法：在群里 @ 它、用 /stop 和 /clear 控制它、互相收发图片和文件、长回复和忙碌时的表现，以及让数字人主动给群发消息。
- [企微机器人显示真实姓名：配置企业微信姓名解析](https://hello-halo.cc/docs/digital-humans/wecom-name-resolution.md): 企业微信会隐藏给机器人发消息的人是谁，Halo 里的联系人只显示一串 ID。在企业微信里授权「消息」能力、把链接粘贴进 Halo，就能显示真实姓名和群名。
- [飞书机器人：扫码创建飞书应用并接入数字人](https://hello-halo.cc/docs/digital-humans/feishu-bot.md): 用手机飞书扫一下，Halo 会替你创建飞书应用并接好数字人，同事私聊或在群里 @ 机器人就能找它办事；也支持 Lark 和手动填写应用 ID。
- [微信机器人：扫码连接个人微信，和数字人聊天](https://hello-halo.cc/docs/digital-humans/personal-wechat.md): 用微信扫一下，就能在自己的微信里私聊 Halo 数字人，不需要企业微信账号。只支持私聊，没有主人和访客的权限区分。
- [通知与主动推送：让数字人自己把结果发出去](https://hello-halo.cc/docs/digital-humans/notifications.md): 让 Halo 数字人主动把结果发出去：发到给机器人发过消息的人和群，或者通过邮件、企业微信、钉钉、飞书应用和 Webhook 这些单向通知通道；也讲清桌面通知怎么设。
- [主人与访客权限：决定谁能通过机器人让数字人做事](https://hello-halo.cc/docs/digital-humans/permissions.md): 用权限控制区分企业微信、飞书机器人的主人和访客：主人能让数字人做任何事，访客默认只能聊天和使用记忆，你可以按需放开查看文件、上网等工具。

## 开发者

### 开始

- [开发者文档：Halo API、Server 与数字人开发](https://hello-halo.cc/docs/developers/index.md): Halo 开发者文档：调用 HTTP API 和 WebSocket，部署 Halo Server，开发数字人，编写技能和 MCP 配置，以及发布数字人包。
- [调用 Halo API：快速上手](https://hello-halo.cc/docs/developers/quickstart.md): 调用 Halo API 的快速上手：打开远程访问，拿到地址和访问密码，用 curl 发出第一个请求，再通过 WebSocket 实时接收回复。
- [给 AI 工具的文档：llms.txt 与 Markdown 版本](https://hello-halo.cc/docs/developers/docs-for-ai.md): 给 AI 工具的文档：Halo 为 AI 读者提供 llms.txt 索引、全文合集和每一页的 Markdown 版本；这里列出地址和内容，并说明 Halo 内置的 AI 怎样读取官方指南。

### HTTP API

- [Halo HTTP API 参考与概览：地址、鉴权和约定](https://hello-halo.cc/docs/developers/api/index.md): Halo HTTP API 概览：基础地址、鉴权、请求与响应约定、错误码和实时事件，以及全部已收录的接口分组。
- [会话 API：发起任务、读取和管理会话](https://hello-halo.cc/docs/developers/api/conversation.md): Halo HTTP API 会话接口：发起一轮任务、停止运行、查看进行中的会话，列出、读取、重命名、星标和删除会话。
- [工作区 API：工作区、文件与记忆](https://hello-halo.cc/docs/developers/api/workspace.md): Halo HTTP API 工作区与文件接口：创建、排序和删除工作区，修改工作区设置与记忆，浏览和读取工作区里的文件。
- [数字人 API：安装、配置和对话](https://hello-halo.cc/docs/developers/api/digital-human.md): Halo HTTP API 数字人接口：安装和卸载、暂停和恢复、修改配置、查看运行记录与活动，以及与数字人对话。
- [团队 API：成员、运行与触发器](https://hello-halo.cc/docs/developers/api/team.md): Halo HTTP API 团队接口：创建和解散团队、管理成员与协作关系、启动和停止运行、设置触发器，查看看板与产出。
- [知识库 API：文档导入与索引](https://hello-halo.cc/docs/developers/api/knowledge-base.md): Halo HTTP API 知识库接口：创建和删除知识库、绑定到工作区或数字人、导入文档并查看索引进度。
- [消息通道 API：即时通讯与通知](https://hello-halo.cc/docs/developers/api/channels.md): Halo HTTP API 消息通道接口：连接和断开即时通讯通道、把聊天绑定到数字人、读取聊天记录、测试通知。
- [设置 API：模型、版本与诊断](https://hello-halo.cc/docs/developers/api/settings.md): Halo HTTP API 设置与模型接口：版本、模型来源与模型切换、安全策略、Agent 引擎和 MCP 服务器诊断。
- [商店 API：浏览、安装与更新](https://hello-halo.cc/docs/developers/api/store.md): Halo HTTP API 商店接口：浏览和搜索商店、查看详情，安装和卸载数字人与技能，管理商店来源与更新。
- [终端 API：创建、输入与回读](https://hello-halo.cc/docs/developers/api/terminal.md): Halo HTTP API 终端接口：创建终端会话、发送输入、调整大小、回读输出和关闭终端会话。
- [Halo API 实用示例：数字人对话、提问与 Webhook](https://hello-halo.cc/docs/developers/api/recipes.md): Halo API 实用示例：和数字人对话、为每位用户分配线程、回答数字人的提问、交换文件、让数字人互相调用，以及用 Webhook 触发运行。
- [WebSocket 事件协议：实时接收 Halo 的进度](https://hello-halo.cc/docs/developers/api/websocket.md): Halo WebSocket 事件参考：连接与鉴权、订阅会话、哪些事件发给谁、事件信封，以及全部事件频道和终端实时流。

### 制作数字人

- [数字人开发概览：组成、运行方式与开发路径](https://hello-halo.cc/docs/developers/digital-humans/index.md): Halo 数字人怎样组成、怎样运行：spec、工作区、记忆和触发方式，一次运行能拿到什么，以及什么时候直接让 Halo 来做、什么时候自己写 spec。
- [教程：做一个浏览器自动化数字人](https://hello-halo.cc/docs/developers/digital-humans/build.md): 教程：把 Halo 的 OA 审批示例改造成一位在你登录的网页系统里工作的数字人，用到随包浏览器脚本、记忆和安全的默认设置。
- [数字人 spec 参考手册：spec.yaml 全部字段说明](https://hello-halo.cc/docs/developers/digital-humans/spec.md): 数字人 spec.yaml 参考：每个字段的类型、默认值和可选值，Halo 会检查的规则，以及写了也没有效果的字段。
- [生产级数字人制作指南：提示词、记忆与浏览器脚本](https://hello-halo.cc/docs/developers/digital-humans/production.md): 让 Halo 数字人稳定地无人值守运行：按步骤写系统提示词，用记忆避免重复，用浏览器脚本自动化网站，处理登录，并给不可撤销的操作设限。
- [DHP 协议：数字人包格式与商店来源](https://hello-halo.cc/docs/developers/dhp.md): DHP（数字人协议）参考：.dhpkg 包的格式和限制，静态商店的目录结构与索引文件，以及 DHP v2 商店服务器额外提供的能力。
- [发布到商店：上架数字人和技能](https://hello-halo.cc/docs/developers/store-publishing.md): 在 Halo 中把数字人或技能发布到商店：填写发布信息、通过发布预检、管理版本和我的发布，以及导出 .dhpkg 或 .zip 包手动分享。

### 扩展

- [编写技能：SKILL.md 格式、脚本与打包](https://hello-halo.cc/docs/developers/skills.md): 为 Halo 编写技能：SKILL.md 的格式和字段，配套文件与脚本，Halo 在哪里找到技能、怎样命名，以及测试和打包分享。
- [MCP 配置参考：字段、传输方式与 JSON 格式](https://hello-halo.cc/docs/developers/mcp.md): Halo 中 MCP 服务器的配置参考：配置字段和传输方式，Halo 接受的 JSON 格式，把 MCP 服务器打包分发，以及数字人怎样获得它们。

### Halo Server

- [Halo Server 快速开始：把 Halo 作为服务运行](https://hello-halo.cc/docs/server/index.md): Halo Server 快速开始：几条命令把 Halo 作为服务运行在 Linux 上，用浏览器打开和桌面版一样的界面，并让后台系统调用它的 API。
- [Halo Server 配置：环境变量参考](https://hello-halo.cc/docs/server/configuration.md): Halo Server 配置参考：用环境变量设置服务模式、端口、数据目录、访问密码，以及企业自有的大模型网关。
- [Docker 部署：在容器中运行 Halo Server](https://hello-halo.cc/docs/server/deployment-docker.md): 用 Docker 部署 Halo Server：从 Halo 主仓库的 deploy/server 构建镜像，挂载持久化数据卷，设置访问密码和自有的大模型网关。
- [Serverless 部署（Knative）：函数平台上的 Halo](https://hello-halo.cc/docs/server/deployment-faas.md): 在 Knative 体系的函数平台上部署 Halo Server：准备镜像、设置环境变量、挂载 NFS 持久卷、分配资源，并避开扩缩容的坑。
- [Halo Server 集成指南：把数字人接入业务系统](https://hello-halo.cc/docs/server/integration.md): Halo Server 集成指南：把数字人作为业务系统的 AI 后端，为每个用户分配聊天线程，用 WebSocket 或轮询取回复。
- [Halo Server 集成示例：curl、WebSocket 与 Java](https://hello-halo.cc/docs/server/examples.md): Halo Server 集成示例：客服数字人的 curl 走查、WebSocket 事件流，以及把异步 API 包成同步 ask() 的 Java 代码。
- [自建镜像与工作原理：从源码构建 Halo Server](https://hello-halo.cc/docs/server/build.md): 自建 Halo Server 镜像：从源码生成部署用的应用包（改品牌、换内置提供商或跟随最新源码时使用），以及无头服务端的工作原理。

## 帮助

### 帮助

- [帮助中心：Halo 问题排查从这里开始](https://hello-halo.cc/docs/troubleshooting/index.md): Halo 出问题时从这里开始：先直接问 Halo，再按报错原文查找，或者按问题类型找到对应的排查页面；还解决不了，带上这些信息来找我们。
- [常见问题 FAQ：Halo 收费、数据、模型和数字人](https://hello-halo.cc/docs/troubleshooting/faq.md): Halo 常见问题的简短回答：要不要钱、数据存在哪里、AI 会不会不打招呼就改文件、支持哪些模型、能不能离线和在手机上用，以及数字人和机器人的常见疑问。
- [常见错误排查：Halo 报错是什么意思、该怎么办](https://hello-halo.cc/docs/troubleshooting/common-errors.md): 按 Halo 里看到的原文查报错：对话中断、模型连不上或被限流、上下文太长、图片和附件、命令执行环境、数字人、机器人和团队的提示，各自的意思和处理办法。
- [模型 API 错误码：401、429、5xx 报错怎么处理](https://hello-halo.cc/docs/troubleshooting/api-errors.md): 模型服务返回 401、402、403、404、429、5xx 等错误时，Halo 里会看到什么、哪些会自动重试，以及该检查 Key、额度、模型配置还是网络。
- [安装与启动问题：系统要求、安全提示和 Git Bash](https://hello-halo.cc/docs/troubleshooting/install.md): Halo 装不上、打不开或第一次启动卡住时看这里：系统版本要求、Mac 和 Windows 的安全提示、Windows 的「需要首次设置」、Linux 的 AppImage，以及日志在哪里。
- [机器人不回复：企业微信、飞书、微信机器人排查](https://hello-halo.cc/docs/troubleshooting/channels.md): 在企业微信、飞书或微信里给 Halo 机器人发消息没有回复时，按这份清单逐项排查：Halo 是否开着、连接状态、绑定的数字人、回复范围、@ 提及和主人。
- [数字人没有运行：定时没开始、未启动和自动停止](https://hello-halo.cc/docs/troubleshooting/digital-humans.md): Halo 数字人到点没有运行、运行记录显示「未启动」、多次失败后自动停止或一直排队时，按这份清单找原因，再让它接着工作。
- [日志与诊断：运行系统诊断、导出报告、找到日志](https://hello-halo.cc/docs/troubleshooting/diagnostics.md): Halo 出问题时怎样自查和收集信息：运行系统诊断和恢复操作，导出诊断报告，找到日志和崩溃报告，用开发者模式记录完整请求，以及反馈问题时附上什么。

### 参考与动态

- [更新日志：Halo 各版本新功能与修复](https://hello-halo.cc/docs/guide/changelog.md): Halo 更新日志：按版本列出每次发布的新功能、改进和修复，最新版本在最前面，内容来自 Halo 的发布说明。
- [联系我们：Halo 用户群、问题反馈和联系方式](https://hello-halo.cc/docs/contact.md): 加入 Halo 微信用户群交流用法，在 GitHub 提交问题和建议，或者通过邮件、X 和 B 站联系 Halo 团队；也说明该去哪里问什么，以及提问前准备哪些信息。

## Halo 助手指南（英文原文，Halo 内置 AI 读取的资料）

- [Halo Official Guides — Index](https://hello-halo.cc/docs/ai-guides/index.md)
- [AI Browser — Controlling Halo's Embedded Browser](https://hello-halo.cc/docs/ai-guides/ai-browser/index.md)
- [browser_run — Writing Production Browser Automation Scripts](https://hello-halo.cc/docs/ai-guides/ai-browser/scripting.md)
- [Configuring AI Models — What Actually Happens in Settings → AI Model](https://hello-halo.cc/docs/ai-guides/ai-model-setup/index.md)
- [AI Model Setup — Troubleshooting](https://hello-halo.cc/docs/ai-guides/ai-model-setup/troubleshooting.md)
- [AI Terminal — A Persistent Terminal Shared with the User](https://hello-halo.cc/docs/ai-guides/ai-terminal/index.md)
- [Worked Examples](https://hello-halo.cc/docs/ai-guides/create-digital-human/examples.md)
- [IM / WeCom Triggering — How It Actually Works](https://hello-halo.cc/docs/ai-guides/create-digital-human/im-triggers.md)
- [Interview Checklist — What to Ask, and What Not To](https://hello-halo.cc/docs/ai-guides/create-digital-human/interview-checklist.md)
- [Creating a Halo Digital Human — What the Tools Don't Tell You](https://hello-halo.cc/docs/ai-guides/create-digital-human/SKILL.md)
- [App Spec Field Reference (condensed, automation-focused)](https://hello-halo.cc/docs/ai-guides/create-digital-human/spec-reference.md)
- [Email Setup — Mailbox Tools vs. Notification Alerts](https://hello-halo.cc/docs/ai-guides/email-setup/index.md)
- [Getting Started — Install, First Run, Updates, and Where Files Live](https://hello-halo.cc/docs/ai-guides/getting-started/index.md)
- [Knowledge Base — Documents the AI Answers From](https://hello-halo.cc/docs/ai-guides/knowledge-base/index.md)
- [Message Channels — WeCom Bot, WeChat iLink Bot, Feishu Bot, and IM Wiring](https://hello-halo.cc/docs/ai-guides/message-channels/index.md)
- [WeCom Intelligent Bot (企业微信智能机器人) — Setup, Permissions, Diagnosis](https://hello-halo.cc/docs/ai-guides/message-channels/wecom-bot.md)
- [WeChat Bot / iLink (微信机器人) — Setup, Limits, Diagnosis](https://hello-halo.cc/docs/ai-guides/message-channels/weixin-ilink.md)
- [Remote Access — HTTP API, Auth, and the Internet Tunnel](https://hello-halo.cc/docs/ai-guides/remote-access/index.md)
- [Skills & MCP — Installing, Scoping, and Authoring](https://hello-halo.cc/docs/ai-guides/skills-and-mcp/index.md)
- [Spaces, Space Conversations, and Digital Humans](https://hello-halo.cc/docs/ai-guides/spaces-and-agents/index.md)