generated from ztimson/template
Use npx instead
This commit is contained in:
55
README.md
55
README.md
@@ -6,29 +6,29 @@
|
||||
<img src="https://git.zakscode.com/repo-avatars/d2c56ffd0220751c2f4a9f6fc1e8125a9a63aeed452ae4f4ab696c084330faa2" alt="Logo" width="200" height="200">
|
||||
|
||||
<!-- Title -->
|
||||
### AI Reviewer
|
||||
### AI Agents
|
||||
|
||||
<!-- Description -->
|
||||
Automated AI-powered code review for pull requests 🤖
|
||||
Automated AI-powered agents for automated reviews and code assistance
|
||||
|
||||
<!-- Repo badges -->
|
||||
[](https://git.zakscode.com/ztimson/ai-reviewer/tags)
|
||||
[](https://git.zakscode.com/ztimson/ai-reviewer/pulls)
|
||||
[](https://git.zakscode.com/ztimson/ai-reviewer/issues)
|
||||
[](https://git.zakscode.com/ztimson/ai-agents/tags)
|
||||
[](https://git.zakscode.com/ztimson/ai-agents/pulls)
|
||||
[](https://git.zakscode.com/ztimson/ai-agents/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>
|
||||
<a href="https://git.zakscode.com/ztimson/ai-agents/releases" target="_blank">Release Notes</a>
|
||||
• <a href="https://git.zakscode.com/ztimson/ai-agents/issues/new?template=.github%2fissue_template%2fbug.md" target="_blank">Report a Bug</a>
|
||||
• <a href="https://git.zakscode.com/ztimson/ai-agents/issues/new?template=.github%2fissue_template%2fenhancement.md" target="_blank">Request a Feature</a>
|
||||
</div>
|
||||
|
||||
---
|
||||
</div>
|
||||
|
||||
## Table of Contents
|
||||
- [AI Reviewer](#top)
|
||||
- [AI Agents](#top)
|
||||
- [About](#about)
|
||||
- [Built With](#built-with)
|
||||
- [Setup](#setup)
|
||||
@@ -37,7 +37,7 @@ Automated AI-powered code review for pull requests 🤖
|
||||
|
||||
## 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.
|
||||
Automated code agents 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
|
||||
[](https://docker.com/)
|
||||
@@ -54,40 +54,7 @@ Automated code reviewer that uses AI to analyze git diffs and provide inline com
|
||||
</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: |
|
||||
echo $GITHUB_WORKSPACE
|
||||
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"
|
||||
```
|
||||
1. Run using npx: `npx @ztimson/ai-agents review`
|
||||
|
||||
</details>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user