Getting Started
Installation
Use this as the canonical setup path for ClawVault + OpenClaw.
Prerequisites
- Node.js 18+
qmdinstalled and available onPATH(qmd --version)
ClawVault currently relies on qmd for core query and context workflows.
1) Install ClawVault CLI
npm install -g clawvault
clawvault --version2) Initialize a Vault
clawvault init ~/memory --name my-brain --qmd-collection my-memory
clawvault setup --theme neural --canvasOptional environment setup:
export CLAWVAULT_PATH="$HOME/memory"3) OpenClaw Hook Setup (Canonical)
openclaw hooks install clawvault
openclaw hooks enable clawvault
# Verify discovery + eligibility + wiring
openclaw hooks list --verbose
openclaw hooks info clawvault
openclaw hooks check
clawvault compatRestart your OpenClaw gateway process after installing/enabling hooks.
Skill vs Hook (Important)
clawhub install clawvaultinstalls skill guidance into workspace flows.openclaw hooks install clawvaultinstalls the runtime hook pack.openclaw hooks enable clawvaultenables the hook entry in OpenClaw config.
For lifecycle automation (gateway:startup, command:new, session:start, etc.), you need the hook install/enable flow.
AGENTS.md Guidance (Safe Change)
Keep your existing AGENTS instructions. Append a minimal ClawVault block:
## ClawVault
- Run `clawvault wake` at session start.
- Run `clawvault checkpoint` during heavy work.
- Run `clawvault sleep "summary" --next "next steps"` at session end.
- Use `clawvault context "<task>"` before complex planning/execution.Do not replace your whole AGENTS.md unless you intentionally want to.
Shell Integration (Optional)
eval "$(clawvault shell-init)"Current aliases added by shell-init:
cvwake->clawvault wakecvsleep->clawvault sleepcvcheck->clawvault doctor
Troubleshooting
openclaw hooks enable clawvault fails (hook not found)
openclaw hooks install clawvault
openclaw hooks list --verboseOpenClaw discovers hooks by precedence:
- workspace hooks (
<workspace>/hooks/) - managed hooks (
~/.openclaw/hooks/) - bundled hooks
If a same-named hook exists in workspace hooks, it can shadow the managed hook.
qmd issues
qmd --version
clawvault doctorValidate integration state
clawvault compat --strict