Get Started
Up and running in 2 minutes. Just terminal commands.
1
Clone & Install
terminal
# Clone the repo
$ git clone https://github.com/vibeforge1111/vibeship-mind.git
Cloning into 'vibeship-mind'...
done.
# Install dependencies
$ cd vibeship-mind
$ uv sync
Resolved 12 packages in 1.2s
Installed 12 packages
If uv sync fails, install uv first
# macOS/Linux
$ curl -LsSf https://astral.sh/uv/install.sh | sh
# Windows (PowerShell)
$ powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
2
Connect to Claude Code
Choose your method:
Option A: Just tell Claude
> Add Mind MCP server from github.com/vibeforge1111/vibeship-mind to my config
Claude will add it to your MCP config automatically.
Option B: Manual config
Mac/Linux: ~/.config/claude/mcp.json
Windows: %APPDATA%\Claude\claude_desktop_config.json
mcp.json
{
"mcpServers": {
"mind": {
"command": "uv",
"args": ["--directory", "/path/to/vibeship-mind", "run", "mind", "mcp"]
}
}
}
Replace /path/to/vibeship-mind with your actual path. Restart Claude Code after.
3
Initialize in Your Project
terminal
$ cd /your/project
$ uv --directory ~/vibeship-mind run mind init
[+] Created .mind/MEMORY.md
[+] Created .mind/SESSION.md
[+] Updated CLAUDE.md with MIND:CONTEXT
[+] Detected stack: typescript, react
[+] Registered project with Mind
Mind initialized! Start working.
4
Verify It Works
claude code
> Check if Mind is working
Claude calls mind_recall()...
## Memory: Active
Last captured: just now
## Project State
- Stack: typescript, react
- Blocked: None
Mind is ready!
How to Use
Mind works automatically. But here are the key tools:
Log a decision
> We decided to use Zustand for state
mind_log("use Zustand for state - simpler than Redux", type="decision")
Logged to MEMORY.md
Set a reminder
> Remind me to add tests when we work on auth
mind_remind("add tests", when="when I mention auth")
Reminder set (context trigger)
Log a blocker
> I'm stuck on the CORS issue
mind_blocker("CORS issue")
Searching memory for related solutions...
Found: "Fixed CORS by adding proxy config"
Check health
$ uv --directory ~/vibeship-mind run mind doctor
[+] Config directory exists
[+] Projects registered: 2
[+] MEMORY.md accessible (4KB)
Overall: Healthy