Documentation

Lyaris quickstart

Lyaris reviews pull requests in three stages. It parses changed files into an AST, sends the changed code plus related files to the Claude API for reasoning, and then writes a test that reproduces each finding before commenting.

1. How a review works

  1. A pull request is opened or updated and the GitHub Action starts.
  2. Lyaris builds a dependency graph of the changed files, API contracts, and migrations.
  3. The Claude API reasons over the graph to flag race conditions and breaking changes.
  4. Each finding is turned into a Vitest or PyTest case and run in CI.
  5. Only findings that reproduce are posted as review comments.

2. Add the GitHub Action

Save this as .github/workflows/lyaris.yml and add LYARIS_API_KEY to your repository secrets.

name: Lyaris PR Review
on:
  pull_request:
    types: [opened, synchronize]

jobs:
  review:
    runs-on: ubuntu-latest
    permissions:
      contents: read
      pull-requests: write
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0
      - name: Run Lyaris review
        run: npx lyaris review --base ${{ github.event.pull_request.base.sha }}
        env:
          LYARIS_API_KEY: ${{ secrets.LYARIS_API_KEY }}
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

3. Configure checks

# .lyaris.yml
include:
  - "src/**"
  - "migrations/**"
exclude:
  - "**/*.generated.ts"
checks:
  race_conditions: true
  api_contracts: true
  test_synthesis: vitest   # or pytest
engine:
  provider: claude-api     # reasoning layer
  retention: none          # no code is stored

4. Data handling

Code is processed in memory for the duration of the review and is not stored. See the Privacy Policy for details.

Support

Questions or private beta access: liyalin@lyaris.me