CLI Reference

claude-mem provides a command-line interface for managing your memory system.

Available Commands

Basic Usage

claude-mem <command> [options]

Global Options

OptionDescription
--versionShow version number
--helpShow help for command
--verboseEnable verbose output
--quietSuppress output

Command Categories

Setup & Configuration

Commands for initial setup and configuration:
  • install - Initial setup
  • uninstall - Remove integration
  • status - Verify installation

Memory Operations

Commands for working with memories:
  • load-context - View memories
  • compress - Manual compression
  • search - Search memories

Maintenance

Commands for system maintenance:
  • logs - View logs
  • trash-view - See trash
  • restore - Recover items
  • clean - Clean old data

Quick Examples

Check Status

claude-mem status

View Recent Memories

claude-mem load-context --limit 5

Check Logs for Issues

claude-mem logs --tail 20

Restore Deleted Memory

claude-mem restore <memory-id>

Output Formats

Commands support multiple output formats:
# Default human-readable
claude-mem status

# JSON output
claude-mem status --json

# Minimal output
claude-mem status --quiet

Configuration File

claude-mem uses ~/.claude-mem/settings.json:
{
  "saveMemoriesOnClear": true,
  "maxMemories": 100,
  "compressionLevel": "balanced",
  "logLevel": "info"
}

Environment Variables

Override settings with environment variables:
VariableDescriptionDefault
CLAUDE_MEM_DIRData directory~/.claude-mem
CLAUDE_MEM_LOG_LEVELLog verbosityinfo
CLAUDE_MEM_MAX_MEMORIESMemory limit100

Exit Codes

claude-mem uses standard exit codes:
CodeMeaning
0Success
1General error
2Missing command
3Invalid arguments
4Installation error
5Permission denied

Scripting

Use claude-mem in scripts:
#!/bin/bash

# Check status and install if needed
if ! claude-mem status --quiet; then
    claude-mem install --force
fi

# Load context and save to file
claude-mem load-context --json > memories.json

# Backup memories
tar -czf backup.tar.gz ~/.claude-mem/

Command Aliases

Common shortcuts:
# Add to your shell profile
alias cm='claude-mem'
alias cms='claude-mem status'
alias cml='claude-mem logs --tail 20'
alias cmc='claude-mem load-context'

Getting Help

Each command has detailed help:
# General help
claude-mem --help

# Command-specific help
claude-mem install --help
claude-mem status --help

Next Steps