Merge branch 'main' into codegate_system_prompt

Author: lukehinds

.github/workflows/ci.yml

@@ -48,6 +48,9 @@ jobs:
     - name: Run linting
       run: make lint
 
+    - name: Run formatting
+      run: make format
+
     - name: Run tests
       run: make test
 

Dockerfile

@@ -0,0 +1,60 @@
+# Builder stage: Install dependencies and build the application
+FROM python:3.12-slim AS builder
+
+# Install system dependencies
+RUN apt-get update && apt-get install -y --no-install-recommends \
+    gcc \
+    g++ \
+    && rm -rf /var/lib/apt/lists/*
+
+# Set environment variable to ensure Python modules are installed in the correct location
+ENV PYTHONPATH=/app
+
+# Install Poetry
+RUN pip install poetry==1.8.4
+
+# Create a non-root user and switch to it
+RUN adduser --system --no-create-home codegate --uid 1000
+
+# Set the working directory
+WORKDIR /app
+
+# Copy only the files needed for installing dependencies
+COPY pyproject.toml poetry.lock* /app/
+
+# Configure Poetry and install dependencies
+RUN poetry config virtualenvs.create false && \
+    poetry install --no-dev
+
+# Copy the rest of the application
+COPY . /app
+
+# Runtime stage: Create the final lightweight image
+FROM python:3.12-slim AS runtime
+
+# Install runtime system dependencies
+RUN apt-get update && apt-get install -y --no-install-recommends \
+    libgomp1 \
+    && rm -rf /var/lib/apt/lists/*
+
+# Create a non-root user and switch to it
+RUN adduser --system --no-create-home codegate --uid 1000
+USER codegate
+
+# Copy necessary artifacts from the builder stage
+COPY --from=builder /usr/local/lib/python3.12/site-packages /usr/local/lib/python3.12/site-packages
+COPY --from=builder /app /app
+
+# Set the working directory
+WORKDIR /app
+
+# Set the PYTHONPATH environment variable
+ENV PYTHONPATH=/app/src
+
+# Allow to expose weaviate_data volume
+VOLUME ["/app/weaviate_data"]
+
+# Set the container's default entrypoint
+EXPOSE 8989
+#ENTRYPOINT ["python", "-m", "src.codegate.cli", "serve", "--port", "8989", "--host", "0.0.0.0"]
+CMD ["python", "-m", "src.codegate.cli", "serve", "--port", "8989", "--host", "0.0.0.0"]

Makefile

@@ -1,4 +1,6 @@
 .PHONY: clean install format lint test security build all
+CONTAINER_BUILD?=docker buildx build
+VER?=0.1.0
 
 clean:
 	rm -rf build/
@@ -27,4 +29,8 @@ security:
 build: clean test
 	poetry build
 
+image-build:
+	$(CONTAINER_BUILD) -f Dockerfile -t codegate . -t ghcr.io/stacklok/codegate:$(VER) --load
+
+
 all: clean install format lint test security build

README.md

@@ -2,109 +2,146 @@
 
 [![CI](https://github.com/stacklok/codegate/actions/workflows/ci.yml/badge.svg)](https://github.com/stacklok/codegate/actions/workflows/ci.yml)
 
-A configurable Generative AI gateway, protecting developers from the dangers of AI.
+Codegate is a local gateway that makes AI coding assistants safer. Acting as a security checkpoint, Codegate ensures AI-generated recommendations adhere to best practices, while safeguarding your code's integrity, and protecting your individual privacy. With Codegate, you can confidently leverage AI in your development workflow without compromising security or control.
 
-## Features
+## ✨ Why Codegate?
 
-- Secrets exflitration prevention
-- Secure Coding recommendations
-- Preventing AI from recommending deprecated and / or malicious libraries
+In today's world where AI coding assistants are becoming ubiquitous, security can't be an afterthought. Codegate sits between you and AI, actively protecting your development process by:
 
+- 🔒 Preventing accidental exposure of secrets and sensitive data
+- 🛡️ Ensuring AI suggestions follow secure coding practices
+- ⚠️ Blocking recommendations of known malicious or deprecated libraries
+- 🔍 Providing real-time security analysis of AI suggestions
 
-### Installation
+## 🌟 Features
 
-#### Requirements
+### Supported AI Providers
+Codegate works seamlessly with leading AI providers:
+- 🤖 Anthropic (Claude)
+- 🧠 OpenAI
+- ⚡ vLLM
+- 💻 Local LLMs (run AI completely offline!)
+- 🔮 Many more on the way!
 
-- [Docker](https://docs.docker.com/get-docker/)
-- [Docker Compose](https://docs.docker.com/compose/install/)
-- [jq](https://stedolan.github.io/jq/download/)
-- [vscode](https://code.visualstudio.com/download)
+### Run AI Your Way
+- 🌐 Cloud Providers: Use leading AI services like OpenAI and Anthropic
+- 🏠 Local LLMs: Keep everything offline with local model support
+- 🔄 Hybrid Mode: Mix and match cloud and local providers as needed
 
-#### Steps
+### AI Coding Assistants
+We're starting with Continue VSCode extension support, with many more AI coding assistants coming soon!
 
-Download the installation script docker-compose.yml
+### Privacy First
+Unlike E.T., your code never phones home! 🛸 Codegate is designed with privacy at its core:
+- 🏠 Everything stays on your machine
+- 🚫 No external data collection
+- 🔐 No calling home or telemetry
+- 💪 Complete control over your data
 
-Run the installation script
+## 🚀 Quick Start
+
+### Prerequisites
+
+Make sure you have these tools installed:
+
+- 🐳 [Docker](https://docs.docker.com/get-docker/)
+- 🔧 [Docker Compose](https://docs.docker.com/compose/install/)
+- 🛠️ [jq](https://stedolan.github.io/jq/download/)
+- 💻 [VSCode](https://code.visualstudio.com/download)
+
+### One-Command Setup
 
 ```bash
 chmod +x install.sh && ./install.sh
 ```
 
-The script will download the Continue VSCode extension, create
-a configuration file. The script will also create a docker-compose.yml file and start the services.
+This script will:
+1. Install the Continue VSCode extension
+2. Set up your configuration
+3. Create and start necessary Docker services
 
-### Usage
+## 🎯 Usage
 
-Tap the Continue button in the VSCode editor to start the service
-to bring up a chat window. The chat window will be displayed in the
-VSCode editor.
+### VSCode Integration with Continue 
 
-![Continue Chat](./static/image.png)
+Simply tap the Continue button in your VSCode editor to start chatting with your AI assistant - now protected by Codegate!
 
-## Usage
+![Continue Chat Interface](./static/image.png)
 
-### Basic Usage (Manual)
-
-Start the server with default settings:
+### Manual Configuration
 
+#### Basic Server Start
 ```bash
 codegate serve
 ```
 
-### Custom Configuration
-
-Start with custom settings:
-
+#### Custom Settings
 ```bash
 codegate serve --port 8989 --host localhost --log-level DEBUG
 ```
 
-### Configuration File
-
-Use a YAML configuration file:
-
-```bash
-codegate serve --config my_config.yaml
-```
-
-Example `config.yaml`:
-
+#### Using Config File
+Create a `config.yaml`:
 ```yaml
 port: 8989
 host: "localhost"
 log_level: "DEBUG"
 ```
 
-### Environment Variables
-
-Configure using environment variables:
+Then run:
+```bash
+codegate serve --config config.yaml
+```
 
+#### Environment Variables
 ```bash
 export CODEGATE_APP_PORT=8989
 export CODEGATE_APP_HOST=localhost
 export CODEGATE_APP_LOG_LEVEL=DEBUG
 codegate serve
 ```
 
-## Development
-
-### Setup
+## 🛠️ Development
 
+### Local Setup
 ```bash
-# Clone the repository
+# Get the code
 git clone https://github.com/stacklok/codegate.git
 cd codegate
 
-# Create and activate a virtual environment
+# Set up virtual environment
 python -m venv venv
 source venv/bin/activate  # On Windows: venv\Scripts\activate
 
-# Install development dependencies
+# Install dev dependencies
 pip install -e ".[dev]"
 ```
 
 ### Testing
-
 ```bash
 pytest
 ```
+
+## 🐳 Docker Deployment
+
+### Build the Image
+```bash
+make image-build
+```
+
+### Run the Container
+```bash
+# Basic usage
+docker run -p 8989:8989 codegate:latest
+
+# With persistent data
+docker run -p 8989:8989 -v /path/to/volume:/app/weaviate_data codegate:latest
+```
+
+## 🤝 Contributing
+
+We welcome contributions! Whether it's bug reports, feature requests, or code contributions, please feel free to contribute to making Codegate better.
+
+## 📜 License
+
+This project is licensed under the terms specified in the [LICENSE](LICENSE) file.

config.yaml.example

@@ -1,19 +1,42 @@
-# Example configuration file
-# Copy this file to config.yaml and modify as needed
+# Codegate Example Configuration
 
-# Server configuration
-port: 8989
-host: "localhost"
+# Network settings
+port: 8989           # Port to listen on (1-65535)
+host: "localhost"      # Host to bind to (use localhost for all interfaces)
 
 # Logging configuration
-log_level: "INFO"  # ERROR, WARNING, INFO, DEBUG
-log_format: "JSON" # JSON, TEXT
+log_level: "INFO"  # One of: ERROR, WARNING, INFO, DEBUG
 
-# Prompts configuration
-# Option 1: Define prompts directly in the config file
-prompts:
-  my_system_prompt: "Custom system prompt defined in config"
-  another_prompt: "Another custom prompt"
+# Note: This configuration can be overridden by:
+# 1. CLI arguments (--port, --host, --log-level)
+# 2. Environment variables (CODEGATE_APP_PORT, CODEGATE_APP_HOST, CODEGATE_APP_LOG_LEVEL)
 
-# Option 2: Reference a separate prompts file
-# prompts: "prompts.yaml"  # Path to prompts file (relative to config file or absolute)
+# Provider URLs
+provider_urls:
+  openai: "https://api.openai.com/v1"
+  anthropic: "https://api.anthropic.com/v1"
+  vllm: "http://localhost:8000"  # Base URL without /v1 path, it will be added automatically
+
+# Note: Provider URLs can be overridden by environment variables:
+# CODEGATE_PROVIDER_OPENAI_URL
+# CODEGATE_PROVIDER_ANTHROPIC_URL
+# CODEGATE_PROVIDER_VLLM_URL
+# Or by CLI flags:
+# --vllm-url
+# --openai-url
+# --anthropic-url
+
+# Embedding model configuration
+
+####
+# Inference model configuration
+##
+
+# Model to use for chatting
+chat_model_path: "./models/qwen2.5-coder-1.5b-instruct-q5_k_m.gguf"
+
+# Context length of the model
+chat_model_n_ctx: 32768
+
+# Number of layers to offload to GPU. If -1, all layers are offloaded.
+chat_model_n_gpu_layers: -1

docs/cli.md

@@ -46,6 +46,21 @@ codegate serve [OPTIONS]
   - Must be a valid YAML file
   - Overrides default prompts and configuration file prompts
 
+- `--vllm-url TEXT`: vLLM provider URL (default: http://localhost:8000)
+  - Optional
+  - Base URL for vLLM provider (/v1 path is added automatically)
+  - Overrides configuration file and environment variables
+
+- `--openai-url TEXT`: OpenAI provider URL (default: https://api.openai.com/v1)
+  - Optional
+  - Base URL for OpenAI provider
+  - Overrides configuration file and environment variables
+
+- `--anthropic-url TEXT`: Anthropic provider URL (default: https://api.anthropic.com/v1)
+  - Optional
+  - Base URL for Anthropic provider
+  - Overrides configuration file and environment variables
+
 ### show-prompts
 
 Display the loaded system prompts:
@@ -100,6 +115,11 @@ Start server with custom prompts:
 codegate serve --prompts my-prompts.yaml
 ```
 
+Start server with custom vLLM endpoint:
+```bash
+codegate serve --vllm-url https://vllm.example.com
+```
+
 Show default system prompts:
 ```bash
 codegate show-prompts