ai-agents/README.md

<!-- Header -->
<div id="top" align="center">
  <br />

  <!-- Logo -->
  <img src="https://git.zakscode.com/repo-avatars/d2c56ffd0220751c2f4a9f6fc1e8125a9a63aeed452ae4f4ab696c084330faa2" alt="Logo" width="200" height="200">

  <!-- Title -->
### AI Reviewer

  <!-- Description -->
Automated AI-powered code review for pull requests 🤖

  <!-- Repo badges -->
[![Version](https://img.shields.io/badge/dynamic/json.svg?label=Version&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/ai-reviewer/tags&query=$[0].name)](https://git.zakscode.com/ztimson/ai-reviewer/tags)
[![Pull Requests](https://img.shields.io/badge/dynamic/json.svg?label=Pull%20Requests&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/ai-reviewer&query=open_pr_counter)](https://git.zakscode.com/ztimson/ai-reviewer/pulls)
[![Issues](https://img.shields.io/badge/dynamic/json.svg?label=Issues&style=for-the-badge&url=https://git.zakscode.com/api/v1/repos/ztimson/ai-reviewer&query=open_issues_count)](https://git.zakscode.com/ztimson/ai-reviewer/issues)

<!-- Links -->
---
  <div>
    <a href="https://git.zakscode.com/ztimson/ai-reviewer/releases" target="_blank">Release Notes</a>
    • <a href="https://git.zakscode.com/ztimson/ai-reviewer/issues/new?template=.github%2fissue_template%2fbug.md" target="_blank">Report a Bug</a>
    • <a href="https://git.zakscode.com/ztimson/ai-reviewer/issues/new?template=.github%2fissue_template%2fenhancement.md" target="_blank">Request a Feature</a>
  </div>

  ---
</div>

## Table of Contents
- [AI Reviewer](#top)
	- [About](#about)
		- [Built With](#built-with)
	- [Setup](#setup)
		- [Production](#production)
	- [License](#license)

## About

Automated code reviewer that uses AI to analyze git diffs and provide inline comments on pull requests. Supports Anthropic, OpenAI, and Ollama models with tool-based reviewing for precise feedback.

### Built With
[![Docker](https://img.shields.io/badge/Docker-384d54?style=for-the-badge&logo=docker)](https://docker.com/)
[![JavaScript](https://img.shields.io/badge/JavaScript-000000?style=for-the-badge&logo=javascript)](https://javascript.com/)
[![Node](https://img.shields.io/badge/Node.js-000000?style=for-the-badge&logo=nodedotjs)](https://nodejs.org/)

## Setup

<details>
<summary>
  <h3 id="production" style="display: inline">
    Production
  </h3>
</summary>

#### Instructions
1. Add the following git action:
```yaml
name: Code review
on:
	pull_request:
		types: [opened, synchronize, reopened]

jobs:
	review:
		runs-on: ubuntu-latest
		container: docker
		steps:
			- name: Fetch code
			  run: |
				  git clone "$(echo ${{github.server_url}}/${{github.repository}}.git | sed s%://%://${{github.token}}@% )" .
				  git checkout ${{ github.event.pull_request.head.sha }}
				  git fetch origin ${{ github.event.pull_request.base.ref }}

			- name: Run AI Review
			  run: |
				  docker pull "git.zakscode.com/ztimson/ai-reviewer:test"
				  docker run --rm -v /github/workspace:/app \
				    -e AI_HOST=anthropic \
				    -e AI_MODEL=claude-sonnet-4-5 \
				    -e AI_TOKEN="${{ secrets.ANTHROPIC_TOKEN }}" \
				    -e GIT_HOST="${{ github.server_url }}" \
				    -e GIT_OWNER="${{ github.repository_owner }}" \
				    -e GIT_REPO="${{ github.event.repository.name }}" \
				    -e GIT_TOKEN="${{ secrets.ASSISTANT_TOKEN }}" \
				    -e GIT_BRANCH="origin/${{ github.event.pull_request.base.ref }}" \
				    -e PULL_REQUEST="${{ github.event.pull_request.number }}" \
				    "git.zakscode.com/ztimson/ai-reviewer:test"

```

</details>

<details>
<summary>
  <h3 id="development" style="display: inline">
    Development
  </h3>
</summary>

#### Prerequisites
- [Node.js](https://nodejs.org/en/download)

#### Instructions
1. Install the dependencies: `npm i`
2. Build library: `npm run review`

</details>

## License

Copyright © 2025 Zakary Timson | All Rights Reserved | Available under MIT Licensing

See the [license](./LICENSE) for more information.