Getting Started

Installation

Install PatchPal from PyPI:

pip install patchpal

Supported Operating Systems: Linux, MacOS, MS Windows.

Setup

1. Get an API key or a Local LLM Engine:
2. [Cloud] For Anthropic models (default): Sign up at https://console.anthropic.com/
3. [Cloud] For OpenAI models: Get a key from https://platform.openai.com/
4. [Local] For vLLM: Install from https://docs.vllm.ai/ (free - no API charges) Recommended for Local Use
5. [Local] For Ollama: Install from https://ollama.com/ (⚠️ requires OLLAMA_CONTEXT_LENGTH=32768 - see Ollama section below)

6. For other providers: Check the LiteLLM documentation

7. Set up your API key as environment variable:

   # For Anthropic (default)
   export ANTHROPIC_API_KEY=your_api_key_here
   
   # For OpenAI
   export OPENAI_API_KEY=your_api_key_here
   
   # For vLLM - API key required only if configured
   export HOSTED_VLLM_API_BASE=http://localhost:8000 # depends on your vLLM setup
   export HOSTED_VLLM_API_KEY=token-abc123           # optional depending on your vLLM setup
   
   # No API required for Ollama.
   
   # For other providers, check LiteLLM docs
   

8. Run PatchPal:

   # Use default model (anthropic/claude-sonnet-4-5)
   patchpal
   
   # Use a specific model via command-line argument
   patchpal --model openai/gpt-5.2-codex  # or openai/gpt-5-mini, anthropic/claude-opus-4-5, etc.
   
   # Use vLLM (local)
   # Note: vLLM server must be started with --tool-call-parser and --enable-auto-tool-choice
   # See "Using Local Models (vLLM & Ollama)" section below for details
   export HOSTED_VLLM_API_BASE=http://localhost:8000
   export HOSTED_VLLM_API_KEY=token-abc123
   patchpal --model hosted_vllm/openai/gpt-oss-20b
   
   # Use Ollama (local - requires OLLAMA_CONTEXT_LENGTH=32768)
   export OLLAMA_CONTEXT_LENGTH=32768
   patchpal --model ollama_chat/gpt-oss:20b
   
   # Or set the model via environment variable
   export PATCHPAL_MODEL=anthropic/claude-opus-4-5
   patchpal