Documentation

1. Initialize a repository

$ contextfs index init

2. Save a memory

$ contextfs memory save "API uses JWT auth" --type fact

3. Search memories

$ contextfs memory search "authentication"

4. Index your codebase

$ contextfs index index

Saving Memories

Save facts, decisions, errors, and procedures that your AI agents can recall later:

# Save a fact
contextfs memory save "Database uses PostgreSQL" --type fact

# Save a decision with rationale
contextfs memory save "Chose React over Vue for component library" --type decision

# Save an error resolution
contextfs memory save "Fixed CORS by adding middleware" --type error

Searching Memories

Use semantic search to find relevant memories:

# Search by topic
contextfs memory search "database configuration"

# Search with type filter
contextfs memory search "auth" --type decision

# Limit results
contextfs memory search "API" --limit 5

Auto-Recall

Automatically load relevant context at session start:

$ contextfs memory auto-recall

Config File Location

ContextFS stores configuration in ~/.contextfs/config.yaml

Example Configuration

# ~/.contextfs/config.yaml
embedding_backend: auto  # auto, fastembed, or sentence_transformers
auto_index: true         # Auto-index on session start
max_results: 10          # Default search result limit

# Cloud sync settings
cloud:
  api_url: https://api.contextfs.ai
  auto_sync: false

Environment Variables

CONTEXTFS_API_KEY=your-api-key    # For cloud sync
CONTEXTFS_DATA_DIR=~/.contextfs   # Data directory

Claude Code

# In your .mcp.json or claude_desktop_config.json
{
  "mcpServers": {
    "contextfs": {
      "command": "uvx",
      "args": ["contextfs"]
    }
  }
}

Cursor

# In Cursor settings, add MCP server:
Command: uvx
Args: contextfs

Programmatic Access

from contextfs import ContextFS

ctx = ContextFS()
ctx.save("API uses JWT", type="fact")
results = ctx.search("authentication")

1. Login to ContextFS Cloud

$ contextfs cloud login

This will open a browser to authenticate with your ContextFS account.

2. Sync Your Memories

# Push local memories to cloud
contextfs cloud sync --direction push

# Pull cloud memories to local
contextfs cloud sync --direction pull

# Two-way sync (default)
contextfs cloud sync

3. Check Sync Status

$ contextfs cloud status

How It Works

• Each device registers with your ContextFS account
• Memories are encrypted locally before upload
• Changes sync automatically in the background
• Conflict resolution preserves both versions

Register a New Device

# On your new device
contextfs cloud login

# Device is automatically registered
contextfs cloud sync

View Connected Devices

$ contextfs cloud devices