Fundamentals
代理工作區
工作區是代理程式的家。它是檔案工具和工作區情境唯一使用的工作目錄。請保持私密,並將它視為記憶。
這與 ~/.openclaw/ 分開;後者儲存設定、憑證和工作階段。
預設位置
- 預設:
~/.openclaw/workspace - 如果已設定
OPENCLAW_PROFILE且不是"default",預設會變成~/.openclaw/workspace-<profile>。 - 在
~/.openclaw/openclaw.json中覆寫:
{
agents: {
defaults: {
workspace: "~/.openclaw/workspace",
},
},
}
openclaw onboard、openclaw configure 或 openclaw setup 會在工作區不存在時建立它,並植入啟動檔案。
如果你已經自行管理工作區檔案,可以停用啟動檔案建立:
{ agents: { defaults: { skipBootstrap: true } } }
額外工作區資料夾
較舊的安裝可能已建立 ~/openclaw。保留多個工作區目錄可能導致令人困惑的驗證或狀態漂移,因為一次只會有一個工作區處於作用中。
工作區檔案對照表
以下是 OpenClaw 預期在工作區內存在的標準檔案:
AGENTS.md - 操作指示
給代理程式的操作指示,以及它應如何使用記憶。每個工作階段開始時載入。適合放置規則、優先順序和「如何行事」細節。
SOUL.md - 人格與語氣
人格、語氣和界線。每個工作階段都會載入。指南:SOUL.md personality guide。
USER.md - 使用者是誰
使用者是誰,以及如何稱呼他們。每個工作階段都會載入。
IDENTITY.md - 名稱、風格、emoji
代理程式的名稱、風格和 emoji。在啟動儀式期間建立/更新。
TOOLS.md - 本機工具慣例
關於你的本機工具和慣例的筆記。不控制工具可用性;它只是指引。
HEARTBEAT.md - Heartbeat 檢查清單
Heartbeat 執行用的可選小型檢查清單。保持簡短以避免消耗 token。
BOOT.md - 啟動檢查清單
Gateway 重新啟動時自動執行的可選啟動檢查清單(啟用 internal hooks 時)。保持簡短;使用訊息工具傳送對外訊息。
BOOTSTRAP.md - 首次執行儀式
一次性的首次執行儀式。只會為全新工作區建立。儀式完成後請刪除它。
memory/YYYY-MM-DD.md - 每日記憶記錄
每日記憶記錄(每天一個檔案)。建議在工作階段開始時讀取今天和昨天。
MEMORY.md - 精選長期記憶(可選)
精選長期記憶。只在主要的私密工作階段載入(不在共享/群組情境中載入)。請參閱 Memory 了解工作流程與自動記憶清空。
skills/ - 工作區 Skills(可選)
工作區專屬 Skills。該工作區中優先順序最高的 skill 位置。當名稱衝突時,會覆寫專案代理程式 Skills、個人代理程式 Skills、受管理 Skills、內建 Skills,以及 skills.load.extraDirs。
canvas/ - Canvas UI 檔案(可選)
節點顯示用的 Canvas UI 檔案(例如 canvas/index.html)。
工作區中不包含什麼
以下位於 ~/.openclaw/ 底下,不應提交到工作區 repo:
~/.openclaw/openclaw.json(設定)~/.openclaw/agents/<agentId>/agent/auth-profiles.json(模型驗證設定檔:OAuth + API keys)~/.openclaw/agents/<agentId>/agent/codex-home/(每個代理程式的 Codex 執行階段帳戶、設定、Skills、plugins,以及原生 thread 狀態)~/.openclaw/credentials/(channel/provider 狀態加上舊版 OAuth 匯入資料)~/.openclaw/agents/<agentId>/sessions/(工作階段紀錄稿 + metadata)~/.openclaw/skills/(受管理 Skills)
如果需要遷移工作階段或設定,請分開複製它們,並讓它們保持在版本控制之外。
Git 備份(建議、私密)
將工作區視為私密記憶。把它放在私密 git repo 中,方便備份與復原。
在 Gateway 執行所在的機器上執行這些步驟(工作區就位於那裡)。
初始化 repo
如果已安裝 git,全新的工作區會自動初始化。如果此工作區還不是 repo,請執行:
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"
新增私密 remote
GitHub web UI
- 在 GitHub 上建立新的私密儲存庫。
- 不要用 README 初始化(避免合併衝突)。
- 複製 HTTPS remote URL。
- 新增 remote 並推送:
git branch -M main
git remote add origin <https-url>
git push -u origin main
GitHub CLI (gh)
gh auth login
gh repo create openclaw-workspace --private --source . --remote origin --push
GitLab web UI
- 在 GitLab 上建立新的私密儲存庫。
- 不要用 README 初始化(避免合併衝突)。
- 複製 HTTPS remote URL。
- 新增 remote 並推送:
git branch -M main
git remote add origin <https-url>
git push -u origin main
持續更新
git status
git add .
git commit -m "Update memory"
git push
不要提交密鑰
建議的 .gitignore 起始內容:
.DS_Store
.env
**/*.key
**/*.pem
**/secrets*
將工作區移到新機器
Clone repo
將 repo clone 到所需路徑(預設 ~/.openclaw/workspace)。
更新設定
在 ~/.openclaw/openclaw.json 中將 agents.defaults.workspace 設為該路徑。
植入缺少檔案
執行 openclaw setup --workspace <path> 以植入任何缺少的檔案。
複製工作階段(可選)
如果需要工作階段,請從舊機器分開複製 ~/.openclaw/agents/<agentId>/sessions/。
進階備註
- 多代理程式路由可以為每個代理程式使用不同工作區。請參閱 Channel routing 了解路由設定。
- 如果已啟用
agents.defaults.sandbox,非主要工作階段可以使用agents.defaults.sandbox.workspaceRoot底下的每工作階段沙箱工作區。
相關
- Heartbeat - HEARTBEAT.md 工作區檔案
- Sandboxing - 沙箱環境中的工作區存取
- Session - 工作階段儲存路徑
- Standing orders - 工作區檔案中的持久指示