Setup overview
1. Create your organization workspace
- Open app.raigal.dev.
- Sign in with GitHub, Google, or your corporate email.
- Open the organization menu in the top-right corner and select Create organization (or select your existing workspace).
- Enter your organization or company name (e.g.,
Acme Corp). - Your workspace is immediately created with an active 14-day evaluation trial.
If you manage multiple teams or sandboxes, switch between organizations using the selector in the top-right corner.
2. Install the Raigal GitHub App
The Raigal GitHub App connects your repositories to the cloud control plane. It registers pending checks on pull requests, resolves check runs when CI completes, and keeps remediation boards updated when PRs merge or close.- In the Raigal Cloud dashboard, go to Settings and select Sync GitHub accounts (or open github.com/apps/raigal-cloud directly).
- Click Install app.
- Select your GitHub organization or personal account.
- Choose All repositories or pick specific repositories to monitor.
- Click Install & authorize.
3. Obtain your organization API token
To allow GitHub Actions runners or local terminals to authenticate and transmit scan metrics to your dashboard:- Open app.raigal.dev/settings.
- Under API Tokens, find the Active organization token card and copy your live key (
rgl_live_...). - To generate a dedicated key for CI or deployment runners, click Create new token, provide a name (e.g.,
github-actions-ci), and copy the displayed token.
In GitHub Actions, you can also use tokenless authentication by including
permissions: id-token: write in your workflow. Raigal Cloud validates the runner using cryptographic GitHub OIDC. Setting RAIGAL_TOKEN in GitHub Secrets is still recommended for multi-platform consistency.4. Add the GitHub Actions workflow
Add.github/workflows/raigal.yml to your repository:
Save the secret in GitHub:
- In your GitHub repository, open Settings > Secrets and variables > Actions.
- Click New repository secret.
- Name:
RAIGAL_TOKEN. - Secret: paste your
rgl_live_...token. - Click Add secret.
5. Verify your first scan
To verify that the integration is working end-to-end:- Pull request scan: Open a pull request in your repository.
- The Raigal GitHub App creates an
in_progresscheck run named Raigal quality gate. - Your GitHub Actions runner executes
raigal ci --changes --base origin/<base>. - The check run finishes with a summary showing the score (0-100), issue counts, and findings breakdown.
- A card appears on your Raigal Cloud dashboard under the Pull Requests tab.
- The Raigal GitHub App creates an
- Main branch scan: Push a commit directly to
main(or merge your PR).- The workflow executes a full scan (
raigal ci .). - The repository baseline health score and active issues update across the Errors and Warnings tabs on app.raigal.dev.
- The workflow executes a full scan (
6. Invite your team
- In Raigal Cloud, navigate to Settings > Members.
- Click Invite member and enter your colleague’s email address.
- Select their role:
- Admin: Full access to manage repository connections, API tokens, billing, and team members.
- Member: Access to view repositories, inspect findings, review PR check runs, and use developer tools.
- The invitee receives an email with an activation link to join your workspace.