Skip to main content

CLI Reference

npm

Give your AI a soul. Install, manage, and switch AI agent personas.

Installation

# Use directly with npx
npx clawsouls <command>

# Or install globally
npm install -g clawsouls

Requirements: Node.js 22+

Commands

clawsouls platform

Show detected agent platform(s) and workspace path.

clawsouls platform
# 🔍 Agent Platform Detection
# ▶ Active: OpenClaw 🦞
# Workspace: /home/user/.openclaw/workspace

clawsouls init [name] [--spec <version>]

Scaffold a new soul package with template files.

clawsouls init my-soul
clawsouls init my-robot --spec 0.5 # Robotics/embodied agents
FlagVersionUse Case
(default)v0.4General-purpose personas
--spec 0.3v0.3Minimal / legacy
--spec 0.5v0.5Robotics / embodied agents

clawsouls install <owner/name[@version]>

Download a soul from the registry.

clawsouls install clawsouls/surgical-coder
clawsouls install clawsouls/surgical-coder@0.1.0 # specific version
clawsouls install clawsouls/surgical-coder --force # overwrite

clawsouls use <name>

Activate an installed soul. Current workspace is automatically backed up.

clawsouls use surgical-coder

Protected files (never overwritten): USER.md, MEMORY.md, TOOLS.md

clawsouls restore

Revert to the previous soul from backup.

clawsouls restore

clawsouls list

List installed souls.

clawsouls list
clawsouls ls

clawsouls validate [dir]

Validate a soul package against the spec.

clawsouls validate              # current directory
clawsouls validate ./my-soul # specific directory
clawsouls validate --soulscan # include security analysis

clawsouls soulscan [dir]

Run SoulScan security and quality analysis.

clawsouls soulscan                # active workspace
clawsouls soulscan ./my-soul # specific directory
clawsouls soulscan -q # quiet mode
clawsouls soulscan --init # initialize checksums

clawsouls publish <dir>

Publish to the registry.

clawsouls login <token>
clawsouls publish ./my-soul

clawsouls export <format>

Export to other framework formats.

clawsouls export claude-md --dir ./my-soul -o CLAUDE.md
clawsouls export cursorrules --dir ./my-soul -o .cursorrules
clawsouls export windsurfrules --dir ./my-soul -o .windsurfrules
clawsouls export system-prompt --dir ./my-soul -o prompt.txt

clawsouls sync

Memory sync commands. See the Memory Sync guide.

clawsouls sync init         # Initialize sync
clawsouls sync push # Encrypt & upload
clawsouls sync pull # Download & decrypt
clawsouls sync status # Show sync state
clawsouls sync export-key # Export encryption key
clawsouls sync import-key # Import key on new device

Platform Override

clawsouls --platform zeroclaw use surgical-coder
clawsouls --workspace ~/custom/path use surgical-coder
CLAWSOULS_PLATFORM=clawdbot clawsouls use surgical-coder