Skip to content

Configure Your OpenClaw Workspace: Setup Guide

Ever felt like your AI agent is losing its mind because it can’t remember where it put its files? Or maybe you’re worried about it accidentally touching files it shouldn’t? Managing an agent’s working environment can be a headache if you don’t have a clear boundary between its “brain” and its “tools.”

The workspace is the agent’s home. It is the only working directory used for file tools and for workspace context. You should keep it private and treat it as memory. This is separate from ~/.openclaw/, which stores your config, credentials, and sessions.

One important thing to remember: the workspace is the default cwd, not a hard sandbox. Tools resolve relative paths against the workspace, but absolute paths can still reach elsewhere on your host unless you enable sandboxing. If you need isolation, use agents.defaults.sandbox (and/or per‑agent sandbox config). When sandboxing is enabled and workspaceAccess is not "rw", tools operate inside a sandbox workspace under ~/.openclaw/sandboxes, not your host workspace.

By default, everything lives at ~/.openclaw/workspace. If you set OPENCLAW_PROFILE to something other than "default", the path changes to ~/.openclaw/workspace-<profile>.

You can override this in your ~/.openclaw/openclaw.json:

{
agent: {
workspace: "~/.openclaw/workspace",
},
}

Running openclaw onboard, openclaw configure, or openclaw setup creates the workspace and seeds the bootstrap files if they are missing. Sandbox seed copies only accept regular in-workspace files; symlink/hardlink aliases that resolve outside the source workspace are ignored.

If you already manage the workspace files yourself, you can disable bootstrap file creation:

{ agent: { skipBootstrap: true } }

Older installs might have created ~/openclaw. Keeping multiple workspace directories around can cause confusing auth or state drift, because only one workspace is active at a time.

I recommend keeping a single active workspace. If you no longer use the extra folders, archive or move them to Trash (for example trash ~/openclaw). If you intentionally keep multiple workspaces, make sure agents.defaults.workspace points to the active one.

openclaw doctor warns you when it detects extra workspace directories.

These are the standard files OpenClaw expects inside the workspace:

  • AGENTS.md: Operating instructions for the agent and how it should use memory. Loaded at the start of every session. This is a good place for rules, priorities, and “how to behave” details.
  • SOUL.md: Persona, tone, and boundaries. Loaded every session.
  • USER.md: Who the user is and how to address them. Loaded every session.
  • IDENTITY.md: The agent’s name, vibe, and emoji. Created/updated during the bootstrap ritual.
  • TOOLS.md: Notes about your local tools and conventions. This does not control tool availability; it is only guidance.
  • HEARTBEAT.md: Optional tiny checklist for heartbeat runs. Keep it short to avoid token burn.
  • BOOT.md: Optional startup checklist executed on gateway restart when internal hooks are enabled. Keep it short; use the message tool for outbound sends.
  • BOOTSTRAP.md: One-time first-run ritual. Only created for a brand-new workspace. Delete it after the ritual is complete.
  • memory/YYYY-MM-DD.md: Daily memory log (one file per day). I recommend reading today + yesterday on session start.
  • MEMORY.md (optional): Curated long-term memory. Only load in the main, private session (not shared/group contexts).

Check out Memory for the workflow and automatic memory flush.

  • skills/ (optional): Workspace-specific skills. These override managed/bundled skills when names collide.
  • canvas/ (optional): Canvas UI files for node displays (for example canvas/index.html).

If any bootstrap file is missing, OpenClaw injects a “missing file” marker into the session and continues. Large bootstrap files are truncated when injected; you can adjust limits with agents.defaults.bootstrapMaxChars (default: 20000) and agents.defaults.bootstrapTotalMaxChars (default: 150000). openclaw setup can recreate missing defaults without overwriting existing files.

These live under ~/.openclaw/ and should NOT be committed to the workspace repo:

  • ~/.openclaw/openclaw.json (config)
  • ~/.openclaw/credentials/ (OAuth tokens, API keys)
  • ~/.openclaw/agents/<agentId>/sessions/ (session transcripts + metadata)
  • ~/.openclaw/skills/ (managed skills)

If you need to migrate sessions or config, copy them separately and keep them out of version control.

Treat the workspace as private memory. Put it in a private git repo so it is backed up and recoverable. Run these steps on the machine where the Gateway runs.

If git is installed, brand-new workspaces are initialized automatically. If this workspace is not already a repo, run:

Terminal window
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) Add a private remote (beginner-friendly options)

Section titled “2) Add a private remote (beginner-friendly options)”

Option A: GitHub web UI

  1. Create a new private repository on GitHub.
  2. Do not initialize with a README.
  3. Copy the HTTPS remote URL.
  4. Add the remote and push:
Terminal window
git branch -M main
git remote add origin <https-url>
git push -u origin main

Option B: GitHub CLI (gh)

Terminal window
gh auth login
gh repo create openclaw-workspace --private --source . --remote origin --push

Option C: GitLab web UI

  1. Create a new private repository on GitLab.
  2. Do not initialize with a README.
  3. Copy the HTTPS remote URL.
  4. Add the remote and push:
Terminal window
git branch -M main
git remote add origin <https-url>
git push -u origin main
Terminal window
git status
git add .
git commit -m "Update memory"
git push

Even in a private repo, avoid storing secrets in the workspace. This includes API keys, OAuth tokens, passwords, or private credentials. Keep anything under ~/.openclaw/ out of the repo. You should also avoid raw dumps of chats or sensitive attachments.

If you must store sensitive references, use placeholders and keep the real secret elsewhere, like a password manager or environment variables.

Here is a suggested .gitignore starter:

.DS_Store
.env
**/*.key
**/*.pem
**/secrets*
  1. Clone the repo to the desired path (default ~/.openclaw/workspace).
  2. Set agents.defaults.workspace to that path in ~/.openclaw/openclaw.json.
  3. Run openclaw setup --workspace <path> to seed any missing files.
  4. If you need sessions, copy ~/.openclaw/agents/<agentId>/sessions/ from the old machine separately.
  • Multi-agent routing can use different workspaces per agent. See Channel routing for routing configuration.
  • If agents.defaults.sandbox is enabled, non-main sessions can use per-session sandbox workspaces under agents.defaults.sandbox.workspaceRoot.

Need help getting your workspace set up? Check out the AI Setup Assistant for a guided experience.

OpenClaw

OpenClaw Expert

Still stuck?

If this page didn't answer your case, ask OpenClaw Expert for step-by-step guidance.