Quick Start

Getting Started

Shiro runs inside your existing GitLab CI or GitHub Actions as a Docker image. No install step. No new infrastructure.

Full documentation →See CI examples

Add the workflow file

Create .shiro/workflows/code-review.json in your repo

Add the config

Create .shiro/config.yaml with your AI provider settings

Add the CI job

Reference the Docker image in your .gitlab-ci.yml or GitHub Actions workflow

GitLab CI

🦊

Add to .gitlab-ci.yml

Use the Docker image — no install step needed

ai-review:
  stage: review
  image: ghcr.io/rajitk13/shiro-automation:latest
  variables:
    GITLAB_TOKEN: $GL_TOKEN
  script:
    - shiro run -workflow .shiro/workflows/code-review.json -config .shiro/config.yaml -state-store gitlab
  artifacts:
    paths:
      - .shiro/state/
    expire_in: 1 day
  only:
    - merge_requests

See the Examples page for more GitLab CI and GitHub Actions configurations.

GitHub Actions

🐙

Add to .github/workflows/review.yml

Container-based execution — same Docker image

name: AI PR Review

on:
  pull_request:
    types: [opened, synchronize, reopened]

jobs:
  ai-review:
    runs-on: ubuntu-latest
    container:
      image: ghcr.io/rajitk13/shiro-automation:latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0
      - name: Run AI Review
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
        run: shiro run -workflow .shiro/workflows/github-mr-review.json -config .shiro/config.yaml

See the Examples page for more GitHub Actions configurations.