Quickstart
Connect your repository and get to your first result.
Before you start
Connect a repository, add one workflow file and open a pull request. A connected repository with an enabled project is enrolled automatically. Public repositories are free; private repositories need Pro, and billing is not open yet.
Check service statusRun a review
- Check your scope. Start with a supported React or Next.js project, committed source and a same-repository pull request. The current Action refuses fork PRs.
- Authorize source processing. Review what files and Git metadata will be submitted. Install the MergeRay GitHub App on the repository and create a project for it in the dashboard.
- Add the workflow. Copy the file shown under Reviews → Setup to .github/workflows/
mergeray.ymlon your default branch. It calls MergeRay's reusable workflow pinned to a full commit and uses GitHub OIDC, so it needs no token. The CLI uses your own CLI token (Manage → CLI tokens) and a Pro seat, so it is not available until billing opens. - Select exact revisions. Both Base and raw Head Git objects must be available locally. Uncommitted edits are not reviewed; missing objects do not trigger an implicit fetch.
- Read the complete outcome. Inspect findings, source locations, coverage and delivery. A missing result or empty findings list is not automatically a pass.
Choose your integration
Install the CLI from npm as mergeray, or use the GitHub Action pinned to a reviewed full commit SHA. Hosted access is enrolled per repository; installing a client does not grant it.
Read the GitHub Action guide