# How to Set Up Rudder AI Reviewer


This guide explains how to set up Rudder AI Reviewer to automatically review pull requests for SDK instrumentation issues.

## Prerequisites

You need the following to get started:

- A GitHub repository with Actions enabled
- Set up a [JavaScript source]({{< ref "sources/event-streams/sdks/rudderstack-javascript-sdk/" >}}) in your RudderStack workspace and note its **Source ID**:

{{< image src="images/ai-features/rudder-ai/source-id.webp" alt="Source ID" >}}

- Generate a [workspace-level Service Access Token]({{< ref "access-management/service-access-tokens.md#workspace-sat" >}}) in your RudderStack workspace.

{{< info >}}
The workspace-level Service Access Token has **Read** permissions by default. You do not need to assign any [resource permissions]({{< ref "access-management/policies-overview.md#resource-permissions" >}}) while generating the token.
{{< /info >}}

#### Token permissions for legacy RBAC system

If you are on the [legacy Permissions Management (RBAC) system]({{< ref "archive/dashboard-guides/user-management.md" >}}), your workspace-level Service Access Token should have **Viewer** permission.

See [this documentation]({{< ref "archive/dashboard-guides/service-access-tokens.md#generate-service-access-token" >}}) for more information on generating the token.

{{< image src="images/access-management/permissions/legacy/viewer.webp" alt="workspace-level Service Access Token with Viewer permission" >}}

## Setup

Add the following workflow to your repository at the `.github/workflows/rudder-ai-reviewer.yml` location:

```yaml
name: Rudder AI Reviewer
on:
  pull_request:
    types: [opened, synchronize]

permissions:
  contents: read        # Required to checkout the repository
  pull-requests: write  # Required to post review comments

jobs:
  review:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # v5.0.1

      - name: Rudder AI Reviewer
        uses: rudderlabs/rudder-ai-reviewer@v1
        with:
          source-id: ${{ secrets.RUDDERSTACK_SOURCE_ID }}
          service-access-token: ${{ secrets.RUDDERSTACK_SERVICE_ACCESS_TOKEN }}
```

### Inputs

| Input | Description | Default value |
| :----|  :----| :-----| 
| `source-id` <br/> <span style="color: #4D4DFF;font-size:12px;">Required</span> | The ID of the source in your RudderStack workspace | - |
| `service-access-token` <br/> <span style="color: #4D4DFF;font-size:12px;">Required</span> | The [workspace-level Service Access Token](#prerequisites) created in your RudderStack workspace | - |
| `root-directory` | Root directory of the project (useful for [monorepos](#monorepo-support)) | - |
| `github-token` | GitHub token for API access | `${{ github.token }}` |

#### Monorepo support

If your repository is a monorepo and the instrumented application is in a subdirectory, use the `root-directory` input to specify the path:

```yaml
- name: Rudder AI Reviewer
  uses: rudderlabs/rudder-ai-reviewer@v1
  with:
    source-id: ${{ secrets.RUDDERSTACK_SOURCE_ID }}
    service-access-token: ${{ secrets.RUDDERSTACK_SERVICE_ACCESS_TOKEN }}
    root-directory: 'apps/frontend'  # Path to your application
```

## Examples

See the [Rudder AI Reviewer GitHub repository](https://github.com/rudderlabs/rudder-ai-reviewer) for examples of the feedback provided by the AI reviewer.

## See more

- [Rudder AI Reviewer Overview]({{< ref "ai-features/rudder-ai-reviewer/" >}})
- [Rudder AI Reviewer Security]({{< ref "ai-features/rudder-ai-reviewer/security.md" >}})
- [Rudder AI Reviewer FAQ]({{< ref "ai-features/rudder-ai-reviewer/faq.md" >}})