Quickstart

Minimal workflow to run Sentinelayer on pull requests in minutes.

  • quickstart
  • workflow

Use this flow for immediate setup.

Minimal workflow


name: Security Review

on:

  pull_request:

permissions:

  contents: read

  pull-requests: write

  checks: write

jobs:

  omar:

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@v4

      - uses: mrrCarter/sentinelayer-v1-action@v1

        with:

          sentinelayer_token: ${{ secrets.SENTINELAYER_TOKEN }}

          severity_gate: P1

          scan_mode: deep

          playwright_mode: baseline

          sbom_mode: baseline

First-run checks

  1. check run exists
  2. comment appears
  3. artifacts are available

Manual deep actions (PR comments)

Use these only when you want extra depth beyond the default PR gate:

  • `/omar baseline` — refresh baseline memory/context
  • `/omar deep-scan` — standard deep review
  • `/omar full-depth` — full-depth audit profile
  • `/omar fix-plan` — remediation plan generation
  • `/omar report` — dashboard-linked report package

Structured Answers

Can quickstart run without extra infrastructure?

Yes. It runs in your existing GitHub Actions runner.

What runs automatically versus manually?

Omar Gate runs automatically on PR checks. Deep/full-depth/fix-plan/report actions are manual comment commands.