hermes-agent/website/i18n/zh-Hans/docusaurus-plugin-content-docs/current/user-guide/profile-distributions.md
Teknium 76135b329d
docs(i18n): translate all docs into Simplified Chinese (zh-Hans) (#31942)
Translates the full English docs corpus (335 files) into Simplified
Chinese under website/i18n/zh-Hans/. Combined with PR #31895 (cross-
locale link fix), the 简体中文 locale toggle now serves a complete
Chinese site with working cross-page navigation.

Pipeline:
- Claude Sonnet 4.6 via OpenRouter, 8-way concurrent
- Preserves frontmatter keys, code blocks, MDX/JSX, link URLs, brand
  names, and technical jargon (prompt/token/hook/MCP/ACP/etc.)
- Translates only frontmatter title/description and prose
- Two largest files (configuration.md 93KB, research-paper-writing.md
  107KB) retried with 64K max_tokens after initial fence-drift
- 3 manual post-fixes for MDX edge cases the model didn't escape:
  < in optional-skills-catalog table, double-quotes in an alt= tag,
  and a bare URL adjacent to a full-width period

Cost: ~$30 total (Sonnet 4.6 input $3/M + output $15/M).

Verified `npm run build` succeeds for both en and zh-Hans locales,
no double-prefixed /docs/zh-Hans/docs/ URLs in rendered output,
all in-page navigation resolves correctly.

Translations are machine-generated and may need human review on
specific pages — but they're an enormous improvement over the
previous state (3 zh-Hans pages out of 335).
2026-05-25 01:47:38 -07:00

21 KiB
Raw Blame History

sidebar_position
3

Profile 分发:共享完整 Agent

Profile 分发将一个完整的 Hermes agent——个性、技能、cron 任务、MCP 连接、配置——打包为一个 git 仓库。任何有权访问该仓库的人都可以用一条命令安装整个 agent就地更新并保持自己的记忆、会话和 API 密钥不受影响。

如果说 profile 是本地 agent那么分发就是让该 agent 可共享的形式。

这意味着什么

在分发功能出现之前,共享一个 Hermes agent 意味着要发送:

  1. 你的 SOUL.md
  2. 需要安装的技能列表
  3. 去掉密钥的 config.yaml
  4. 接入了哪些 MCP 服务器的说明
  5. 你设置的所有 cron 任务
  6. 需要设置哪些环境变量的说明

……然后祈祷对方能正确组装。每次版本升级或修复 bug 都意味着重复这一过程。

有了分发功能,这一切都存放在一个 git 仓库中:

my-research-agent/
├── distribution.yaml    # manifest: name, version, env-var requirements
├── SOUL.md              # the agent's personality / system prompt
├── config.yaml          # model, temperature, reasoning, tool defaults
├── skills/              # bundled skills that come with the agent
├── cron/                # scheduled tasks the agent runs
└── mcp.json             # MCP servers the agent connects to

接收方运行:

hermes profile install github.com/you/my-research-agent --alias

……他们就拥有了完整的 agent。填入自己的 API 密钥(.env.EXAMPLE.env),即可运行 my-research-agent chat,或通过 Telegram / Discord / Slack / 任何 gateway 平台与其交互。当你推送新版本时,他们运行 hermes profile update my-research-agent 即可拉取你的更改——他们的记忆和会话保持不变。

为什么选择 git

我们考虑过 tarball、HTTP 归档、自定义格式,但都比不上 git

  • 作者无需构建步骤。 推送到 GitHub用户即可安装。没有"打包、上传、更新索引"的循环。
  • 标签、分支和提交本身就是版本管理系统。 推送一个 tag 就能完成其他工具需要"打包 + 上传发布"才能做到的事。
  • 更新只需 fetch。 不需要重新下载整个归档。
  • 透明。 用户可以浏览仓库、阅读版本间的 diff、提 issue、fork 后自定义。
  • 私有仓库开箱即用。 SSH 密钥、git credential helper、GitHub CLI 存储的凭据——终端已配置好的任何认证方式都能透明生效。
  • 可复现性即 commit SHA。 与 pip 和 npm 的记录方式相同。

权衡之处:接收方需要安装 git。在 2026 年运行 Hermes 的任何机器上,这已是既成事实。

什么时候应该使用分发?

适合的场景:

  • 你要共享一个专用 agent——合规监控器、代码审查员、研究助手、客服机器人——给团队或社区。
  • 你要将同一个 agent 部署到多台机器,不想每次手动复制文件。
  • 你在迭代一个 agent,希望接收方用一条命令就能获取新版本。
  • 你在将 agent 作为产品构建——有主见的默认配置、精选技能、调优的 prompt提示词——供他人作为起点使用。

不适合的场景:

  • 你只想在自己的机器上备份一个 profile。 使用 hermes profile export / import——那正是这两个命令的用途。
  • 你想随 agent 一起共享 API 密钥。 auth.json.env 被刻意排除在分发之外。每个安装者使用自己的凭据。
  • 你想共享记忆 / 会话 / 对话历史。 这些是用户数据,不是分发内容,永远不会被发送。

生命周期:从作者到安装者再到更新

以下是完整的端到端流程,选择你关心的一侧阅读。


作者篇:发布分发

第一步——从一个可用的 profile 开始

像构建其他 profile 一样构建并打磨 agent

hermes profile create research-bot
research-bot setup                    # configure model, API keys
# Edit ~/.hermes/profiles/research-bot/SOUL.md
# Install skills, wire up MCP servers, schedule cron jobs, etc.
research-bot chat                     # dogfood until it feels right

第二步——添加 distribution.yaml

创建 ~/.hermes/profiles/research-bot/distribution.yaml

name: research-bot
version: 1.0.0
description: "Autonomous research assistant with arXiv and web tools"
hermes_requires: ">=0.12.0"
author: "Your Name"
license: "MIT"

# Tell installers which env vars the agent needs. These are checked against
# the installer's shell and existing .env file so they don't get nagged
# about keys they already have configured.
env_requires:
  - name: OPENAI_API_KEY
    description: "OpenAI API key (for model access)"
    required: true
  - name: SERPAPI_KEY
    description: "SerpAPI key for web search"
    required: false
    default: ""

这就是完整的 manifest。除 name 外,每个字段都有合理的默认值。

第三步——推送到 git 仓库

cd ~/.hermes/profiles/research-bot
git init
git add .
git commit -m "v1.0.0"
git remote add origin git@github.com:you/research-bot.git
git tag v1.0.0
git push -u origin main --tags

该仓库现在就是一个分发。任何有访问权限的人都可以安装它。

:::note git 仓库包含 profile 目录中除已从分发中排除的内容之外的所有内容auth.json.envmemories/sessions/state.db*logs/workspace/*_cache/local/。这些文件保留在你的机器上。你也可以添加 .gitignore 来排除其他路径。 :::

第四步——为版本发布打标签

每当 agent 达到稳定状态时,升级版本号并打标签:

# Edit distribution.yaml: version: 1.1.0
git add distribution.yaml SOUL.md skills/
git commit -m "v1.1.0: tighter research SOUL, add arxiv skill"
git tag v1.1.0
git push --tags

运行 hermes profile update research-bot 的接收方将拉取最新版本。

仓库结构示例

一个完整的分发仓库:

research-bot/
├── distribution.yaml            # required
├── SOUL.md                      # strongly recommended
├── config.yaml                  # model, provider, tool defaults
├── mcp.json                     # MCP server connections
├── skills/
│   ├── arxiv-search/SKILL.md
│   ├── paper-summarization/SKILL.md
│   └── citation-lookup/SKILL.md
├── cron/
│   └── weekly-digest.json       # scheduled tasks
└── README.md                    # human-facing description (optional)

分发所有权 vs 用户所有权

当安装者更新到新版本时,某些内容会被替换(作者的领域),某些内容保持不变(安装者的领域)。默认规则:

类别 路径 更新时
分发所有 SOUL.mdconfig.yamlmcp.jsonskills/cron/distribution.yaml 从新克隆中替换
配置覆盖 config.yaml 默认实际保留——安装者可能已调整模型或 provider。更新时传入 --force-config 可重置。
用户所有 memories/sessions/state.db*auth.json.envlogs/workspace/plans/home/*_cache/local/ 永不触碰

你可以在 manifest 中覆盖分发所有列表:

distribution_owned:
  - SOUL.md
  - skills/research/            # only my research skills; other installed skills stay
  - cron/digest.json

省略时,上述默认规则生效——大多数分发都适用。


安装者篇:使用分发

安装

hermes profile install github.com/you/research-bot --alias

执行过程:

  1. 将仓库克隆到临时目录。
  2. 读取 distribution.yaml,显示 manifest名称、版本、描述、作者、所需环境变量
  3. 对照你的 shell 环境和目标 profile 现有的 .env 检查每个必需的环境变量,标记为 ✓ setneeds setting,让你清楚需要配置哪些内容。
  4. 请求确认。传入 -y / --yes 可跳过。
  5. 将分发所有的文件复制到 ~/.hermes/profiles/research-bot/(或 manifest 中 name 解析到的位置)。
  6. 写入 .env.EXAMPLE,其中所需密钥以注释形式列出——复制为 .env 并填入。
  7. 使用 --alias 时,创建一个 wrapper使你可以直接运行 research-bot chat

来源类型

任何 git URL 均可使用:

# GitHub shorthand
hermes profile install github.com/you/research-bot

# Full HTTPS
hermes profile install https://github.com/you/research-bot.git

# SSH
hermes profile install git@github.com:you/research-bot.git

# Self-hosted, GitLab, Gitea, Forgejo — any Git host
hermes profile install https://git.example.com/team/research-bot.git

# Private repo using your configured git auth
hermes profile install git@github.com:your-org/internal-bot.git

# Local directory during development (no git push needed)
hermes profile install ~/my-profile-in-progress/

覆盖 profile 名称

两个用户希望以不同的 profile 名称使用同一个分发:

# Alice
hermes profile install github.com/acme/support-bot --name support-us --alias
# Bob同一分发不同本地名称
hermes profile install github.com/acme/support-bot --name support-eu --alias

填写环境变量

安装后agent 的 profile 中包含一个 .env.EXAMPLE

# Environment variables required by this Hermes distribution.
# Copy to `.env` and fill in your own values before running.

# OpenAI API key (for model access)
# (required)
OPENAI_API_KEY=

# SerpAPI key for web search
# (optional)
# SERPAPI_KEY=

复制它:

cp ~/.hermes/profiles/research-bot/.env.EXAMPLE ~/.hermes/profiles/research-bot/.env
# Edit .env, paste your real keys

已在你的 shell 环境中存在的必需密钥(例如在 ~/.zshrc 中 export 的 OPENAI_API_KEY)在安装时会被标记为 ✓ set——无需在 .env 中重复填写。

查看已安装内容

hermes profile info research-bot

显示:

Distribution: research-bot
Version:      1.0.0
Description:  Autonomous research assistant with arXiv and web tools
Author:       Your Name
Requires:     Hermes >=0.12.0
Source:       https://github.com/you/research-bot
Installed:    2026-05-08T17:04:32+00:00

Environment variables:
  OPENAI_API_KEY (required) — OpenAI API key (for model access)
  SERPAPI_KEY (optional) — SerpAPI key for web search

hermes profile list 还会显示 Distribution 列,让你一眼看出哪些 profile 来自仓库,哪些是手动构建的:

 Profile          Model                        Gateway      Alias        Distribution
 ───────────────    ───────────────────────────    ───────────    ───────────    ────────────────────
 ◆default         claude-sonnet-4              stopped      —            —
  coder           gpt-5                        stopped      coder        —
  research-bot    claude-opus-4                stopped      research-bot research-bot@1.0.0
  telemetry       claude-sonnet-4              running      telemetry    telemetry@2.3.1

更新

hermes profile update research-bot

执行过程:

  1. 从记录的来源 URL 重新克隆仓库。
  2. 替换分发所有的文件SOUL、skills、cron、mcp.json
  3. 保留你的 config.yaml——你可能已调整了模型、temperature 或其他设置。传入 --force-config 可覆盖。
  4. 永不触碰用户数据记忆、会话、auth、.env、日志、state。

不需要重新下载整个归档,不会覆盖你对配置的本地修改,不会删除你的对话历史。

删除

hermes profile delete research-bot

删除确认提示会在要求你确认之前显示分发信息:

Profile: research-bot
Path:    ~/.hermes/profiles/research-bot
Model:   claude-opus-4 (anthropic)
Skills:  12
Distribution: research-bot@1.0.0
Installed from: https://github.com/you/research-bot

This will permanently delete:
  • All config, API keys, memories, sessions, skills, cron jobs
  • Command alias (~/.local/bin/research-bot)

Type 'research-bot' to confirm:

这样你就不会在不知道 agent 来源或无法重新安装的情况下意外删除它。


使用场景与模式

个人:跨机器同步同一个 agent

你在笔记本上构建了一个研究助手,想在工作站上使用同一个 agent。

# 笔记本
cd ~/.hermes/profiles/research-bot
git init && git add . && git commit -m "initial"
git remote add origin git@github.com:you/research-bot.git
git push -u origin main

# 工作站
hermes profile install github.com/you/research-bot --alias
# 填写 .env完成。

在笔记本上的任何迭代(git commit && push)都可以通过 hermes profile update research-bot 同步到工作站。记忆按机器独立保存——笔记本记住自己的对话,工作站记住自己的,互不干扰。

团队:发布经过审核的内部 agent

你的工程团队需要一个共享的 PR 审查机器人,具有特定的 SOUL、特定的技能以及一个对每个 PR 运行审查的 cron 任务。

# 工程负责人
cd ~/.hermes/profiles/pr-reviewer
# ... build and tune ...
git init && git add . && git commit -m "v1.0 PR reviewer"
git tag v1.0.0
git push -u origin main --tags    # push to your company's internal Git host

# 每位工程师
hermes profile install git@github.com:your-org/pr-reviewer.git --alias
# 填写 .env使用自己的 API 密钥(费用由自己承担),.env.EXAMPLE 指明了所需内容
pr-reviewer chat

当负责人发布 v1.1(更好的 SOUL、新技能工程师运行 hermes profile update pr-reviewer,所有人在几分钟内就能用上新版本。

社区:发布公开 agent

你构建了一些新颖的东西——也许是"Polymarket 交易员"、"学术论文摘要器"或"Minecraft 服务器运维助手"。你想分享它。

# 你
cd ~/.hermes/profiles/polymarket-trader
# 在仓库根目录写一个完整的 README.md——GitHub 会在仓库页面展示它
git init && git add . && git commit -m "v1.0"
git tag v1.0.0
# 发布到公开 GitHub 仓库
git remote add origin https://github.com/you/hermes-polymarket-trader.git
git push -u origin main --tags

# 任何人
hermes profile install github.com/you/hermes-polymarket-trader --alias

发推分享安装命令。尝试的人会给你提 issue 和 PR。想要自定义的人可以 fork——与大家已熟悉的 git 工作流完全相同。

产品:发布有主见的 agent

你在 Hermes 之上构建了产品——也许是合规监控框架、客服技术栈、特定领域的研究平台。你想以产品形式分发它。

# distribution.yaml
name: telemetry-harness
version: 2.3.1
description: "Compliance telemetry harness — monitors and reviews regulated workflows"
hermes_requires: ">=0.13.0"
author: "Acme Compliance Inc."
license: "Commercial"

env_requires:
  - name: ACME_API_KEY
    description: "Your Acme Compliance license key (email support@acme.com)"
    required: true
  - name: OPENAI_API_KEY
    description: "OpenAI API key for model access"
    required: true
  - name: GRAPHITI_MCP_URL
    description: "URL for your Graphiti knowledge graph instance"
    required: false
    default: "http://127.0.0.1:8000/sse"

你的客户通过一条命令完成安装;安装预览会告诉他们需要准备哪些密钥;你打上新 tag 的那一刻更新就能推出;他们的合规数据(memories/sessions/)永远不会离开他们的机器。

临时:在共享基础设施上运行一次性脚本

你是运维负责人,需要一个临时 agent 来诊断生产事故——一个预设好 SOUL、配备正确工具和 MCP 连接的 agent——在三位值班工程师的笔记本上运行一周。

# 你
# 构建 profile提交推送到私有仓库
git push -u origin main

# 每位值班人员
hermes profile install git@github.com:your-org/incident-2026-q2.git --alias

# 事故解决——清理
hermes profile delete incident-2026-q2

安装-删除的成本足够低,可以当作一次性工具使用。


实用技巧

固定到特定版本

:::note Git ref 固定(#v1.2.0)已在规划中,但不在初始版本中——目前安装时跟踪默认分支。通过 hermes profile info <name> 查看已安装版本,在准备好之前暂缓更新。 :::

查看当前版本与最新版本

# 你已安装的版本
hermes profile info research-bot | grep Version

# 上游最新版本(不安装)
git ls-remote --tags https://github.com/you/research-bot | tail -5

在更新时保留本地配置自定义

默认的更新行为已经做到这一点:config.yaml 会被保留。为了安全起见,将本地调整写入分发不拥有的文件:

# ~/.hermes/profiles/research-bot/local/my-overrides.yaml
# (distribution never touches local/)

……并在 config.yaml 或 SOUL 中按需引用。

强制全新重装

# 彻底删除并重新安装(记忆/会话也会丢失)
hermes profile delete research-bot --yes
hermes profile install github.com/you/research-bot --alias

# 更新到当前 main但将 config.yaml 重置为分发默认值
hermes profile update research-bot --force-config --yes

Fork 并自定义

标准 git 工作流——分发就是仓库:

# 在 GitHub 上 fork 仓库,然后安装你的 fork
hermes profile install github.com/yourname/forked-research-bot --alias

# 在 ~/.hermes/profiles/forked-research-bot/ 中本地迭代
# 编辑 SOUL.md提交推送到你的 fork
# 上游变更:用常规方式合并到你的 fork

推送前测试分发

在作者机器上:

# 从本地目录安装(无需 git push
hermes profile install ~/.hermes/profiles/research-bot --name research-bot-test --alias

# 调整、删除、重新安装,直到满意
hermes profile delete research-bot-test --yes
hermes profile install ~/.hermes/profiles/research-bot --name research-bot-test

分发中永远不包含的内容

即使作者不小心将以下路径提交到仓库,安装器也会硬性排除它们。没有任何配置选项可以覆盖此行为——这是经过回归测试的不变量:

  • auth.json — OAuth token、平台凭据
  • .env — API 密钥、密钥信息
  • memories/ — 对话记忆
  • sessions/ — 对话历史
  • state.dbstate.db-shmstate.db-wal — 会话元数据
  • logs/ — agent 和错误日志
  • workspace/ — 生成的工作文件
  • plans/ — 草稿计划
  • home/ — Docker 后端中用户的 home 挂载
  • *_cache/ — 图片 / 音频 / 文档缓存
  • local/ — 用户保留的自定义命名空间

克隆分发时,这些内容根本不存在。更新时,它们保持原样。如果你在五台机器上安装了同一个分发,你就拥有五套独立的此类数据——每台机器各一份。

安全与信任

Profile 分发默认不带签名。你信任的是:

  • git 托管平台GitHub / GitLab / 其他平台)能够提供作者推送的原始内容。
  • 作者不会发布恶意的 SOUL、技能或 cron 任务。

来自分发的 cron 任务不会自动调度——安装器会打印 hermes -p <name> cron list你需要显式启用它们。SOUL.md 和技能在你开始与 profile 对话后立即生效,因此如果你从不熟悉的来源安装,请在第一次运行前阅读它们。

粗略类比:安装分发就像安装浏览器扩展或 VS Code 扩展。低摩擦、高权限,信任来源。对于公司内部分发,使用私有仓库和你现有的 git 认证——无需额外配置。

未来版本可能会添加签名、带有已解析 commit SHA 的 lockfile.distribution-lock.yaml),以及在应用更新前打印 diff 的 --dry-run 标志。这些功能目前尚未发布。

底层实现

有关实现细节、精确的 CLI 行为和所有标志,请参阅 Profile 命令参考

简要说明:

  • installupdateinfo 位于 hermes profile 下——不是独立的命令树。
  • manifest 格式为 YAMLschema 极简(仅 name 为必填)。
  • 安装器使用你本地的 git 二进制文件进行克隆,因此 shell 已处理的任何认证SSH 密钥、credential helper都能透明生效。
  • 克隆完成后,.git/ 会被剥离——已安装的 profile 本身不是 git checkout避免了"不小心将 .env 提交到分发 git 历史"的陷阱。
  • 保留的 profile 名称(hermestesttmprootsudo)在安装时会被拒绝,以避免与常见二进制文件冲突。

另请参阅