7.4 KiB
read_when, summary, title, x-i18n
| read_when | summary | title | x-i18n | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
智能体工作区:位置、布局和备份策略 | 智能体工作区 |
|
智能体工作区
工作区是智能体的“家”。它是文件工具和工作区上下文所使用的唯一工作目录。请将其保持为私有,并将其视为记忆。
这与存储配置、凭证和会话的 ~/.openclaw/ 是分开的。
重要:工作区是默认 cwd,而不是硬性沙箱。工具会相对于工作区解析相对路径,但除非启用沙箱隔离,否则绝对路径仍然可以访问主机上的其他位置。如果你需要隔离,请使用 agents.defaults.sandbox(和/或按智能体配置的沙箱)。启用沙箱隔离后,如果 workspaceAccess 不是 "rw",工具会在 ~/.openclaw/sandboxes 下的沙箱工作区中运行,而不是在你的主机工作区中运行。
默认位置
- 默认值:
~/.openclaw/workspace - 如果设置了
OPENCLAW_PROFILE且其值不是"default",默认值将变为~/.openclaw/workspace-<profile>。 - 在
~/.openclaw/openclaw.json中覆盖:
{
agent: {
workspace: "~/.openclaw/workspace",
},
}
openclaw onboard、openclaw configure 或 openclaw setup 会在工作区缺失时创建工作区并植入引导文件。
沙箱种子复制仅接受工作区内的常规文件;解析到源工作区外部的符号链接/硬链接别名会被忽略。
如果你已经自行管理工作区文件,可以禁用引导文件创建:
{ agent: { skipBootstrap: true } }
额外的工作区文件夹
较旧的安装可能创建过 ~/openclaw。保留多个工作区目录可能会导致令人困惑的凭证或状态漂移,因为同一时间只有一个工作区处于活动状态。
**建议:**只保留一个活动工作区。如果你不再使用额外的文件夹,请将其归档或移到废纸篓(例如 trash ~/openclaw)。
如果你有意保留多个工作区,请确保
agents.defaults.workspace 指向当前活动的那个。
当 openclaw doctor 检测到额外的工作区目录时,会发出警告。
工作区文件映射(每个文件的含义)
以下是 OpenClaw 在工作区内预期的标准文件:
-
AGENTS.md- 智能体的操作说明,以及它应如何使用记忆。
- 每次会话开始时加载。
- 很适合放置规则、优先级和“如何表现”之类的细节。
-
SOUL.md- 人设、语气和边界。
- 每次会话都会加载。
-
USER.md- 用户是谁,以及应如何称呼他们。
- 每次会话都会加载。
-
IDENTITY.md- 智能体的名称、风格和 emoji。
- 在引导仪式期间创建/更新。
-
TOOLS.md- 关于你的本地工具和约定的说明。
- 它不控制工具可用性;仅提供指导。
-
HEARTBEAT.md- 可选的心跳运行微型检查清单。
- 保持简短以避免消耗过多 token。
-
BOOT.md- 可选的启动检查清单;当启用内部 hooks 时,会在 Gateway 网关重启时执行。
- 保持简短;出站发送请使用消息工具。
-
BOOTSTRAP.md- 一次性的首次运行仪式。
- 仅为全新的工作区创建。
- 仪式完成后请将其删除。
-
memory/YYYY-MM-DD.md- 每日记忆日志(每天一个文件)。
- 建议在会话开始时阅读今天和昨天的内容。
-
MEMORY.md(可选)- 精选的长期记忆。
- 仅在主私有会话中加载(不在共享/群组上下文中加载)。
有关工作流和自动记忆刷新,请参见记忆。
-
skills/(可选)- 工作区专用技能。
- 名称冲突时会覆盖托管/捆绑的 Skills。
-
canvas/(可选)- 用于节点显示的 Canvas UI 文件(例如
canvas/index.html)。
- 用于节点显示的 Canvas UI 文件(例如
如果任何引导文件缺失,OpenClaw 会在会话中注入一个“缺失文件”标记并继续执行。注入时,大型引导文件会被截断;可使用 agents.defaults.bootstrapMaxChars(默认:20000)和 agents.defaults.bootstrapTotalMaxChars(默认:150000)调整限制。
openclaw setup 可以重新创建缺失的默认文件,而不会覆盖现有文件。
不在工作区中的内容
这些内容位于 ~/.openclaw/ 下,不应提交到工作区仓库:
~/.openclaw/openclaw.json(配置)~/.openclaw/credentials/(OAuth 令牌、API 密钥)~/.openclaw/agents/<agentId>/sessions/(会话记录和元数据)~/.openclaw/skills/(托管 Skills)
如果你需要迁移会话或配置,请单独复制它们,并确保不要将其纳入版本控制。
Git 备份(推荐,私有)
将工作区视为私有记忆。把它放进一个私有 git 仓库,以便备份并可恢复。
请在 Gateway 网关运行的机器上执行这些步骤(工作区就位于那里)。
1)初始化仓库
如果已安装 git,全新工作区会自动初始化。如果这个工作区还不是仓库,请运行:
cd ~/.openclaw/workspace
git init
git add AGENTS.md SOUL.md TOOLS.md IDENTITY.md USER.md HEARTBEAT.md memory/
git commit -m "Add agent workspace"
2)添加私有远程仓库(适合新手的选项)
选项 A:GitHub Web UI
- 在 GitHub 上创建一个新的私有仓库。
- 不要使用 README 初始化(以避免合并冲突)。
- 复制 HTTPS 远程 URL。
- 添加远程仓库并推送:
git branch -M main
git remote add origin <https-url>
git push -u origin main
选项 B:GitHub CLI(gh)
gh auth login
gh repo create openclaw-workspace --private --source . --remote origin --push
选项 C:GitLab Web UI
- 在 GitLab 上创建一个新的私有仓库。
- 不要使用 README 初始化(以避免合并冲突)。
- 复制 HTTPS 远程 URL。
- 添加远程仓库并推送:
git branch -M main
git remote add origin <https-url>
git push -u origin main
3)持续更新
git status
git add .
git commit -m "Update memory"
git push
不要提交密钥
即使在私有仓库中,也应避免在工作区中存储密钥:
- API 密钥、OAuth 令牌、密码或私有凭证。
~/.openclaw/下的任何内容。- 聊天原始转储或敏感附件。
如果你必须存储敏感引用,请使用占位符,并将真实密钥保存在其他地方(密码管理器、环境变量或 ~/.openclaw/)。
建议的 .gitignore 起始内容:
.DS_Store
.env
**/*.key
**/*.pem
**/secrets*
将工作区迁移到新机器
- 将仓库克隆到所需路径(默认是
~/.openclaw/workspace)。 - 在
~/.openclaw/openclaw.json中将agents.defaults.workspace设置为该路径。 - 运行
openclaw setup --workspace <path>以植入任何缺失的文件。 - 如果你需要会话,请将旧机器上的
~/.openclaw/agents/<agentId>/sessions/单独复制过来。
高级说明
- 多智能体路由可以为不同智能体使用不同的工作区。有关路由配置,请参见 渠道路由。
- 如果启用了
agents.defaults.sandbox,非主会话可以在agents.defaults.sandbox.workspaceRoot下使用按会话划分的沙箱工作区。