diff --git a/README.md b/README.md index ade64dcaae..128d0db5c7 100644 --- a/README.md +++ b/README.md @@ -31,10 +31,13 @@ PR-Agent is an open-source, AI-powered code review agent and a community-maintai ### 🚀 Quick Start for PR-Agent #### 1. Try it Instantly (No Setup) + Test PR-Agent on any public GitHub repository by commenting `@CodiumAI-Agent /improve` #### 2. GitHub Action (Recommended) + Add automated PR reviews to your repository with a simple workflow file: + ```yaml # .github/workflows/pr-agent.yml name: PR Agent @@ -54,6 +57,7 @@ jobs: [Full GitHub Action setup guide](https://qodo-merge-docs.qodo.ai/installation/github/#run-as-a-github-action) #### 3. CLI Usage (Local Development) + Run PR-Agent locally on your repository: ```bash pip install pr-agent @@ -63,6 +67,7 @@ pr-agent --pr_url https://github.com/owner/repo/pull/123 review [Complete CLI setup guide](https://qodo-merge-docs.qodo.ai/usage-guide/automations_and_usage/#local-repo-cli) #### 4. Other Platforms + - [GitLab webhook setup](https://qodo-merge-docs.qodo.ai/installation/gitlab/) - [BitBucket app installation](https://qodo-merge-docs.qodo.ai/installation/bitbucket/) - [Azure DevOps setup](https://qodo-merge-docs.qodo.ai/installation/azure/)