Skip to content

QUICKSTART.md

Latest commit

 

History

History
143 lines (100 loc) · 3.33 KB

QUICKSTART.md

File metadata and controls

143 lines (100 loc) · 3.33 KB
Raw

Quick Start Guide

Get up and running with Claude Context Kit in 5 minutes.

Prerequisites

Installation

Option 1: Clone and Install (Recommended)

# Clone the repository
git clone https://github.com/your-username/claude-context-kit.git
cd claude-context-kit

# Run the installer
node install.js

Option 2: One-Line Install

Unix/Mac:

curl -sL https://raw.githubusercontent.com/your-username/claude-context-kit/main/install.sh | bash

Windows PowerShell:

irm https://raw.githubusercontent.com/your-username/claude-context-kit/main/install.ps1 | iex

What Gets Installed

The installer will:

  1. Copy hooks to ~/.claude/hooks/
  2. Copy commands to ~/.claude/commands/
  3. Install skill-generator to ~/.claude/skills/
  4. Install the semantic memory daemon to ~/.claude/memory/daemon/
  5. Configure settings.json with hook registrations
  6. Initialize the SQLite database

First Steps

1. Start a New Session

Just start Claude Code as normal:

claude

The session will automatically be registered in the session registry.

2. Try Smart Fork Detection

When starting work on a task, find relevant past sessions:

/fork-detect implement user authentication

This searches your session history for semantically similar work.

3. Resume a Previous Session

If you have pending work from a previous session:

/resume

This lists sessions with handoff prompts ready to continue.

4. Store Learnings

When you discover something important:

/learn

This extracts and stores learnings to semantic memory.

Key Commands

Command Purpose
/fork-detect <task> Find similar past sessions
/prime-fork <session-id> Load context from a session
/resume Continue from a pending session
/learn Store learnings to memory
/sync-registry Update session summaries
/create-skill Create a project context skill

Migrating Existing Sessions

If you have existing Claude Code history:

/migrate-sessions

This imports all historical sessions into the registry and builds the search index.

Verify Installation

After installation, verify everything is working:

# Check hooks installed
ls ~/.claude/hooks/

# Check commands installed
ls ~/.claude/commands/

# Check daemon files
ls ~/.claude/memory/daemon/

# Test daemon (start in background first)
cd ~/.claude/memory/daemon && python server.py &
curl http://localhost:8741/health

Troubleshooting

Hooks Not Firing

  • Check ~/.claude/settings.json has hooks configured
  • On Windows, ensure PowerShell execution policy allows scripts

Daemon Not Starting

  • Check Python 3.8+ is installed
  • Install dependencies: pip install flask sentence-transformers torch

Memory Recall Not Working

  • Ensure daemon is running on port 8741
  • Check ~/.claude/memory/semantic-memory.db exists

For more detailed troubleshooting, see TROUBLESHOOTING.md.

Next Steps