PR Collab Agent 🤖

An autonomous software engineering peer that lives in your repository.

The PR Collab Agent helps you build better systems whilst ensuring you understand your own code. It acts as a "Tool for Thought" rather than a blind automation tool.

🚀 Usage

1. Create an Issue: Open an issue for your task (e.g., "Refactor the authentication logic").
2. Plan: Comment /agent plan on the issue. The agent will analyse your request and propose a plan.
3. Execute: Comment /agent execute. The agent will write the code and open a Pull Request.
4. Review: Answer the stewardship questions in the PR description before merging.

🛠️ Installation

You can run the agent locally using Node.js or in an isolated container using Docker.

Prerequisites

• A GitHub account.
• A GitHub App (see Setup Guide).
• Google Gemini API Key.

Option A: Node.js (Local)

1. Install dependencies:

   npm install

2. Configure: Run the setup wizard:

   node scripts/setup.js

3. Run in CLI Mode (Manual):

   npm run cli <owner> <repo> <issue_number>

4. Run in Webhook Mode (Automatic):

   npm start

   See Webhook Setup Guide to configure GitHub.

Option B: Docker (Container)

1. Build the image:

   docker build -t pr-collab-agent .

2. Run the container:

   docker run -p 3000:3000 --env-file .env pr-collab-agent

🧠 Philosophy

This tool follows the AI Stewardship Cycle to prevent skill atrophy.

1. Architect: The agent plans with you.
2. Integrator: The agent writes the code for you. It uses a deterministic branch name (pr-collab-agent/issue-{number}) to ensure a stable workflow.
3. Trainer: The agent ensures you understand the work.

📖 Read the full AI Stewardship Framework