|
| 1 | +# CodeRabbit Plugin for Antigravity |
| 2 | + |
| 3 | +Run CodeRabbit reviews from Antigravity, understand the findings, and fix issues |
| 4 | +within your requested scope. The plugin also provides a separate workflow for |
| 5 | +unresolved CodeRabbit feedback on existing GitHub pull requests. |
| 6 | + |
| 7 | +## Status |
| 8 | + |
| 9 | +Initial package, version 0.1.0. The repository has package validation, regression |
| 10 | +tests, and reproducible upstream imports. Loading and running the plugin in |
| 11 | +Antigravity still requires the [smoke test](docs/smoke-test.md). |
| 12 | +Marketplace review and publication are pending. |
| 13 | + |
| 14 | +## Requirements |
| 15 | + |
| 16 | +- Google Antigravity with native plugin support. |
| 17 | +- Git and a project in an initialized Git repository. |
| 18 | +- [CodeRabbit CLI](https://docs.coderabbit.ai/cli) installed from an official source |
| 19 | + and authenticated in the environment where the review runs. |
| 20 | +- GitHub CLI (`gh`) authenticated for existing GitHub PR autofix workflows. |
| 21 | + |
| 22 | +CodeRabbit reviews send the selected code diff to the CodeRabbit API. Use the |
| 23 | +review scope you intend to share, and exclude secrets. The plugin does not |
| 24 | +include an MCP server or automatically install software. |
| 25 | + |
| 26 | +## Install |
| 27 | + |
| 28 | +Clone this repository and install the local package with Antigravity CLI: |
| 29 | + |
| 30 | +```bash |
| 31 | +git clone https://github.com/coderabbitai/antigravity-plugin.git |
| 32 | +cd antigravity-plugin |
| 33 | +agy plugin install . |
| 34 | +agy plugin list |
| 35 | +``` |
| 36 | + |
| 37 | +Confirm that `coderabbit` appears with the two skills, agents, and routing rule. |
| 38 | +Reload your Antigravity session if the components are not visible immediately. |
| 39 | + |
| 40 | +For the standalone Antigravity IDE, clone the package to a workspace plugin folder: |
| 41 | + |
| 42 | +```bash |
| 43 | +git clone https://github.com/coderabbitai/antigravity-plugin.git .agents/plugins/coderabbit |
| 44 | +``` |
| 45 | + |
| 46 | +For all IDE workspaces, use `~/.gemini/config/plugins/coderabbit` instead. Inspect |
| 47 | +the loaded components through the agent panel's Customizations menu. Install at |
| 48 | +one scope initially to avoid duplicate components. |
| 49 | + |
| 50 | +These paths follow Google's [plugin installation documentation](https://antigravity.google/docs/plugins). |
| 51 | +Local installation does not add the plugin to the Marketplace. |
| 52 | + |
| 53 | +## Use |
| 54 | + |
| 55 | +Ask the agent naturally: |
| 56 | + |
| 57 | +```text |
| 58 | +Use CodeRabbit to review my changes. |
| 59 | +Review my uncommitted changes, including new untracked files. |
| 60 | +Review this branch against main with CodeRabbit. |
| 61 | +Build this feature, review it with CodeRabbit, fix the confirmed issues, and review again. |
| 62 | +Show unresolved CodeRabbit feedback on this PR and propose fixes. |
| 63 | +``` |
| 64 | + |
| 65 | +Antigravity converts skill names into slash commands. The bundled skills expose: |
| 66 | + |
| 67 | +```text |
| 68 | +/coderabbit-review |
| 69 | +/coderabbit-autofix |
| 70 | +``` |
| 71 | + |
| 72 | +See Google's [skill invocation documentation](https://antigravity.google/docs/skills). |
| 73 | + |
| 74 | +### Local coding, review, and fix |
| 75 | + |
| 76 | +The review skill checks the selected repository and authentication, then runs the |
| 77 | +trusted CodeRabbit CLI with `review --agent` and the requested scope. It reports |
| 78 | +the findings at their original severity. If you request fixes, the agent checks |
| 79 | +the code, applies authorized changes, and runs relevant validation. Review loops |
| 80 | +use your run limit or at most three review invocations per change set. |
| 81 | + |
| 82 | +A failed, skipped, interrupted, or partial review is reported with its limitation. |
| 83 | +It is not reported as a clean review. If login is needed, complete it in your |
| 84 | +terminal; the plugin never reads or copies your credentials. |
| 85 | + |
| 86 | +### Existing GitHub PR feedback |
| 87 | + |
| 88 | +The autofix skill requires a clean worktree and local HEAD matching the exact PR |
| 89 | +head, with a submitted CodeRabbit review for that commit. It fetches current, |
| 90 | +unresolved threads, checks each issue locally, and presents proposed changes for |
| 91 | +per-fix approval. Pushes and PR comments follow your explicit authorization. |
| 92 | + |
| 93 | +Use `--no-commit` in your request to keep approved fixes local and uncommitted. |
| 94 | +This workflow does not create a new PR or automatically publish comments. |
| 95 | + |
| 96 | +## Package layout |
| 97 | + |
| 98 | +```text |
| 99 | +plugin.json |
| 100 | +skills/ |
| 101 | + coderabbit-review/SKILL.md |
| 102 | + coderabbit-review/references/ |
| 103 | + coderabbit-autofix/SKILL.md |
| 104 | +agents/ |
| 105 | + coderabbit-reviewer.md |
| 106 | + coderabbit-autofix-planner.md |
| 107 | +rules/ |
| 108 | + coderabbit-review-routing.md |
| 109 | +``` |
| 110 | + |
| 111 | +The root manifest uses Antigravity's format. Branding and package version live in |
| 112 | +this README and development metadata, rather than unsupported manifest fields. |
| 113 | +Skills and agents are adapted from pinned CodeRabbit sources. See |
| 114 | +[upstream maintenance](CONTRIBUTING.md). |
| 115 | + |
| 116 | +## Development and Marketplace submission |
| 117 | + |
| 118 | +```bash |
| 119 | +npm ci |
| 120 | +npm run check |
| 121 | +npm run package |
| 122 | +``` |
| 123 | + |
| 124 | +Node.js 22 or newer is needed for development. Python 3 creates a deterministic |
| 125 | +ZIP in `dist/` with `plugin.json` at its root. Antigravity users do not need Node |
| 126 | +or Python merely to load these Markdown components. |
| 127 | + |
| 128 | +The checks validate package files and references; they do not replace testing |
| 129 | +actual discovery, authentication, review output, and fixes in Antigravity. |
| 130 | +Follow the [smoke test](docs/smoke-test.md) and |
| 131 | +[Marketplace submission guide](docs/marketplace-submission.md) before a release. |
| 132 | + |
| 133 | +## License |
| 134 | + |
| 135 | +MIT. See [LICENSE](LICENSE). |
0 commit comments