Getting Started

Prerequisites

Before you begin, make sure you have:

Bun runtime installed (install Bun)
Claude Code or OpenCode with plugin support (for automatic integration)

Quick Start

Option 1: Claude Code Plugin (Recommended)

The easiest way to get started is with the Claude Code plugin:

Terminal

# In Claude Code terminal:
/plugin marketplace add jagjeevanak/mem-oracle

That's it! The plugin will:

Auto-install dependencies
Auto-start the worker service in the background
Auto-inject relevant documentation into your prompts

Option 2: Manual Installation

For more control, you can install manually:

Terminal

# Clone and install
git clone https://github.com/jagjeevanak/mem-oracle.git
cd mem-oracle
bun install

# Start the worker service
bun run worker

Option 3: MCP Server

Add to your Claude Code MCP configuration:

.mcp.json

{
  "mcpServers": {
    "mem-oracle": {
      "command": "mem-oracle",
      "args": ["mcp"]
    }
  }
}

If you're running from source, use bun run /path/to/mem-oracle/src/index.ts mcp.

Your First Index

Once the worker is running, index your first documentation: If you're running from source, replace mem-oracle with bun run src/index.ts.

Terminal

# Index Next.js docs
mem-oracle index https://nextjs.org/docs/getting-started

# Or via HTTP API
curl -X POST http://localhost:7432/index \
  -H "Content-Type: application/json" \
  -d '{"baseUrl": "https://nextjs.org", "seedSlug": "/docs/getting-started"}'

Searching Documentation

Search your indexed documentation:

Terminal

# Via CLI
mem-oracle search "how to use server components"

# Via HTTP API
curl -X POST http://localhost:7432/retrieve \
  -H "Content-Type: application/json" \
  -d '{"query": "how to use server components", "topK": 5}'

Check Status

View the status of your indexed documentation:

Terminal

# Via CLI
mem-oracle status

# Via HTTP API
curl http://localhost:7432/status

Next Steps

Installation Guide - Detailed setup for different platforms
Configuration - Customize Mem- Oracle settings
CLI Reference - All available commands

Getting Started

On this page