Skip to content

Getting started

Requirements

  • Drupal 11.4 or later within Drupal 11.x.
  • AI Code Review UI 1.x and its Composer dependencies.
  • A Drupal project with a recipes/ directory.
  • Drush 13 or later, or Drupal core's Recipe command.
  • Git when using the development checkout described below.
  • A separately installed AI Code Review Server for submitting reviews.

Release and development versions

The published 1.0.0-alpha1 Recipe does not import the supplied review policy and review-list configuration on a fresh UI site. The fix for the configuration import defect is on the 1.x development branch and is not included in that alpha package. For evaluation with that fix, use the 1.x source checkout below. Check the project releases for a packaged release containing the fix before switching to a release package.

The source checkout is a development version and Composer does not update it. Use it on an evaluation site, review changes before updating it, and back up an existing site before applying any Recipe.

Install the UI and obtain the Recipe

From the Drupal project root, install the UI and its dependencies with Composer:

composer require drupal/ai_code_review_ui:1.0.0-alpha1

If recipes/ai_code_review does not already exist, obtain the Recipe source:

mkdir -p recipes
git clone --branch 1.x --single-branch https://git.drupalcode.org/project/ai_code_review.git recipes/ai_code_review

Do not overwrite an existing Recipe directory. Check the branch and commit before applying a development checkout. The Recipe requires Drupal 11.4 and the UI module's declared dependencies; it does not install the Server.

Apply the Recipe

Review existing configuration and role assignments first. If the ai_code_review_user role already exists, the Recipe preserves its label and other permissions and adds the three review permissions described in Reviewer access.

From the Drupal web root, apply the Recipe with Drush:

../vendor/bin/drush recipe ../recipes/ai_code_review

Alternatively, use Drupal core's Recipe command:

php core/scripts/dr recipe ../recipes/ai_code_review -v

These paths assume the common project layout with web/, vendor/, and recipes/ under the project root. Adjust them for a different layout.

Assign the reviewer role to appropriate accounts, then connect the two sites. A Recipe provides initial configuration; it is not an update, uninstall, or rollback mechanism. See the Drupal Recipes guide for more information.