Skip to content

Quick Start

Start the Application

# Activate virtual environment
source .venv/bin/activate

# Start API and Web UI
python cli.py serve

Visit http://localhost:5173 for the web interface.

Your First Crawl

Via Web UI

  1. Navigate to the "Crawl" page
  2. Click "New Crawl"
  3. Enter documentation name and URL
  4. Click "Start Crawl"

Via CLI

python cli.py crawl start "React" https://react.dev/reference --depth 2

Search for Code

Via Web UI

Use the search bar on the dashboard or search page.

Via CLI

python cli.py search "authentication middleware"

Via MCP

MCP tools are available when the API server is running:

curl http://localhost:8000/mcp/tools