Quickstart
From zero to your first findings: sign in, connect a repo, and read what Hyrax found. Once you pick a repository, the first run is automatic.
1. Sign in, then connect your repos
There's no separate signup or password to set up. You sign in — continue with Google, or a one-time email code — which creates your account. If you already sign in with GitHub, that keeps working. Then you create your workspace — Hyrax asks for your name, your company name, and your company URL. From there you connect a GitHub organization (or personal account) by installing the Hyrax GitHub App on it, and choose which repositories the App can access (all or specific ones). You can change that selection later in GitHub. The GitHub App is only for repository access, not for logging in.
Hyrax verifies your email as part of signing in — there's nothing extra to configure, and your account is protected by a security factor automatically. During early access, a new workspace may need approval before its first run — if you land on a "pending approval" screen, you're in the queue.
2. The onboarding wizard
The first time you open a workspace with no repositories, Hyrax shows a short onboarding wizard:
| Step | What you do |
|---|---|
| Connect GitHub | Connect the organization (or personal account) whose repos you want by installing the Hyrax GitHub App on it. Once it's connected the wizard shows "✓ Connected to <org>". |
| Pick a repository | Choose your first repository. You can add more later. |
| Confirm & start | Pick the branch, review what will run, and start. Hyrax registers the repo, kicks off discovery (about ten minutes), and switches PR review on for it. No audit runs on its own — your first audit is a deliberate click once discovery finishes. |
3. What happens automatically
Connecting your first repo starts one job for you — you don't submit it by hand, and the repo page shows live progress so you can follow along:
- Discovery runs the moment your first repository is registered (and on any public repository you add by URL). It profiles the repo — architecture, conventions, how-to knowledge — and stores that context in your workspace. Repositories you add after that don't discover on their own: run Discovery from the repo's Discovery tab when you're ready.
- PR review switches on for the repository. From then on, Hyrax reviews pull requests as you open them — no further setup.
An audit is always something you choose to run, and a repo has to finish Discovery first. It comes in two depths, both on every plan — Standard and Full; Audit depth covers what each one runs and how the audit button's level picker works.
4. Read your first findings
Run your first audit from the repo page once discovery finishes (the audit button is disabled until then), and open the repo's findings list when it completes. Each one is an observation with a stable ref like HYRAX-42, a priority (P0–P3), a category, a description of what's wrong and why, and the file locations it touches. From there you can open an observation, click Fix to have Hyrax open a pull request, or dismiss anything not worth acting on — your triage is remembered when audits re-run.
Connecting public repositories
You can point Hyrax at a public GitHub repository by URL without installing the App on the upstream org. These repos run read-only: audits and discovery work, and a review can be started through the API with its findings shown in Hyrax (nothing posts to GitHub) — but Fix, which writes back to your repo, needs the App installed. Adding public repos by URL is available on every plan. See Public & private repositories.
Next steps
- Running audits & fixes — the day-to-day guide, plus Findings & suggestions.
- How Hyrax works — the audit engine, end to end.
- Plans & pricing — what your plan includes.