DOCUMENTATION
Installation
Detailed setup instructions for LumenCore.
//Requirements
Node.js18 or higher
Claude Codewith MCP support
//Install Globally
terminal
npm install -g lumencore//Run Setup
terminal
lumencore setupMemory Scope Options
Project-only
ISOLATEDEach project has its own isolated memory. Best for unrelated projects.
Project + Global
SHAREDProject memories plus shared global memory. Best for related projects or personal preferences.
Data Directory
Default locations:
default-paths
# Linux
~/.local/share/lumencore
# macOS
~/Library/Application Support/lumencore
# Windows
%LOCALAPPDATA%\lumencore//Connect to Claude Code
Option 1: CLI Command
terminal
claude mcp add lumencore -- lumencore serveOption 2: Manual Configuration
Add to your Claude Code MCP settings:
mcp-settings.json
{
"mcpServers": {
"lumencore": {
"command": "lumencore",
"args": ["serve"]
}
}
}//CLI Commands
lumencore init | Initialize LumenCore in current project |
lumencore setup | Run the global setup wizard |
lumencore serve | Start the MCP server (used by Claude Code) |
lumencore status | Show configuration and memory stats |
lumencore export | Export memories to JSON for backup/migration |
lumencore version | Show installed version |
lumencore reset | Clear all data (use --force to confirm) |
lumencore help | Show help |
//Export Options
terminal
lumencore export # Export current project memories
lumencore export --global # Export global memories only
lumencore export --all # Export all memories
lumencore export -o backup.json # Custom output file//Configuration
Config file location:
config-paths
# Linux
~/.config/lumencore/config.json
# macOS
~/Library/Preferences/lumencore/config.json
# Windows
%APPDATA%\lumencore\config.jsonExample configuration:
config.json
{
"memoryScope": "project-only",
"dataDir": "~/.local/share/lumencore",
"defaultImportance": 3,
"maxContextTokens": 4000
}