Skip to content

Document persistence of SOUL.md, USER.md, IDENTITY.md and provide backup/restore guidance #434

@lellky

Description

@lellky

Problem:

NemoClaw/OpenClaw creates important configuration files inside the sandbox — SOUL.md, USER.md, and IDENTITY.md — located at /sandbox/.openclaw/workspace/. These files define the agent's personality, user preferences, and identity. However:

  1. No documentation mentions these files exist, what they do, or where they're stored.
  2. The files do not survive gateway destroy — sandbox data lives in a PVC inside the k3s cluster, so while it survives sandbox restarts, destroying the gateway loses everything.
  3. There is no built-in backup/restore mechanism for these files. Users must manually discover the correct path and use openshell sandbox download/upload to preserve them.

What we had to do to figure this out:

• The files are not at /sandbox/SOUL.md as one might guess — they're at /sandbox/.openclaw/workspace/SOUL.md (and similarly for the others). We had to download the entire /sandbox/ directory to discover this.
• We wrote custom backup/restore shell scripts using openshell sandbox download and openshell sandbox upload to transfer these files to/from the host.

Suggestions:

  1. Document the workspace files (SOUL.md, USER.md, IDENTITY.md) — what they are, where they live, and that they're user-customizable.
  2. Add a built-in openshell sandbox backup/openshell sandbox restore command (or nemoclaw backup/nemoclaw restore) that handles these files automatically.
  3. Alternatively, support persistent host volume mounts for the workspace directory so these files survive gateway recreation.
  4. At minimum, warn users during gateway destroy that sandbox data (including these files) will be lost.

Environment: OpenShell 0.0.10, NemoClaw on Ubuntu Linux.

Feel free to edit as needed before posting.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Getting StartedUse this label to identify setup, installation, or onboarding issues.documentationImprovements or additions to documentationpriority: highImportant issue that should be resolved in the next release

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions