Introduction

Mind Palace is a deterministic context system for codebases. Unlike RAG or embedding-based approaches, Mind Palace provides schema-validated, verifiable context that both humans and AI agents can trust.

Installation

macOS


# Apple Silicon (M1/M2/M3)
curl -LO https://github.com/koksalmehmet/mind-palace/releases/latest/download/palace-darwin-arm64.pkg
sudo installer -pkg palace-darwin-arm64.pkg -target /
 
# Intel Mac
curl -LO https://github.com/koksalmehmet/mind-palace/releases/latest/download/palace-darwin-amd64.pkg
sudo installer -pkg palace-darwin-amd64.pkg -target /

Linux


# Debian/Ubuntu (x64)
curl -LO https://github.com/koksalmehmet/mind-palace/releases/latest/download/palace-linux-amd64.deb
sudo dpkg -i palace-linux-amd64.deb
 
# Debian/Ubuntu (ARM64)
curl -LO https://github.com/koksalmehmet/mind-palace/releases/latest/download/palace-linux-arm64.deb
sudo dpkg -i palace-linux-arm64.deb
 
# Other Linux (manual)
curl -LO https://github.com/koksalmehmet/mind-palace/releases/latest/download/palace-linux-amd64.tar.gz
tar xzf palace-linux-amd64.tar.gz
sudo mv palace /usr/local/bin/

Windows

Download and run the MSI installer from the releases page .

Or via PowerShell:


Invoke-WebRequest -Uri "https://github.com/koksalmehmet/mind-palace/releases/latest/download/palace-windows-amd64.msi" -OutFile palace.msi
Start-Process msiexec.exe -Wait -ArgumentList '/i palace.msi /quiet'

Verify Installation


palace version

Quick Start

1. Initialize Your Project


cd your-project
palace init --detect

This creates the .palace/ directory with:

palace.jsonc - Project configuration
rooms/ - Auto-detected room definitions based on your project structure
playbooks/ - Workflow templates

2. Build the Index


palace scan

This creates a SQLite database with full-text search (FTS5) containing:

File metadata and hashes
Symbols (functions, types, classes)
Call relationships (extracted via Tree-sitter or LSP)

For Dart/Flutter projects, deep analysis with LSP runs automatically to extract accurate call graphs.

3. Explore Your Codebase


palace explore "where is authentication handled"

Results are ranked using BM25 with entry-point boosting.

4. Store Knowledge


palace store "We decided to use JWT for authentication"

Auto-classifies as decision, idea, or learning (95%+ accuracy).

5. Get Context for AI Agents


palace explore "fix the login bug" --full

This creates a context pack with relevant files, learnings, and decisions.

What’s Next

Concepts - Learn the core terminology
Workflows - Day-to-day usage patterns
CLI Reference - All available commands