Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 31 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,9 @@

<h1 align="center">Code<a href="https://github.com/khezen/codespy">Spy</a></h1>

<p align="center">
<strong>Automated code reviews for teams who care about correctness.</strong>
</p>
<p align="center">
An open-source AI reviewer that catches bugs, improves code quality, and integrates directly into your PR workflow, without sacrificing control or security.
</p>
<p align="center">
<i>"Fast feedback. No black box. No vendor lock-in."</i>
</p>

<p align="center">
<a href="https://github.com/khezen/codespy/actions">
Expand All @@ -31,6 +25,37 @@

---

## Table of Contents

- [Why CodeSpy?](#why-codespy)
- [Features](#features)
- [Installation](#installation)
- [Using pip](#using-pip)
- [Using Homebrew (macOS/Linux)](#using-homebrew-macoslinux)
- [Using Docker](#using-docker)
- [Using Poetry (for development)](#using-poetry-for-development)
- [Quick Start](#quick-start)
- [Usage](#usage)
- [Command Line](#command-line)
- [Using Docker](#using-docker-1)
- [GitHub Action](#github-action)
- [Configuration](#configuration)
- [Setup](#setup)
- [Git Platform Tokens](#git-platform-tokens)
- [LLM Provider](#llm-provider)
- [Advanced Configuration (YAML)](#advanced-configuration-yaml)
- [Recommended Model Strategy](#recommended-model-strategy)
- [Output](#output)
- [Markdown (default)](#markdown-default)
- [GitHub/GitLab Review Comments](#githubgitlab-review-comments)
- [Architecture](#architecture)
- [DSPy Signatures](#dspy-signatures)
- [Supported Languages](#supported-languages)
- [Development](#development)
- [License](#license)

---

## Why CodeSpy?

Most AI code reviewers are:
Expand Down