Skip to main content

Quickstart

From zero to your first findings: sign in, add a repository, run an audit, and turn what it finds into work.

1. Sign in and create your workspace​

There's no password to set up. Sign in with your email, which sends you a one-time code, or continue with Google or GitHub. Signing in creates your account.

Then name your workspace: Hyrax asks for your name, your company name and your company URL. Choose Create workspace and you're in.

Your new workspace comes ready to use. It has one Area and one Space, both named Default, and every repository you add lands in the Default Space. While you have only one of each, the app doesn't mention Areas or Spaces: you see your workspace and its projects. You can arrange things later. See Organizing work.

Joining a teammate's workspace is by invitation: see Members & roles.

2. Add your first repository​

Open Workspace settings from the menu at the foot of the rail, go to Repositories, and choose Add repositories. There are two ways in:

  • With the Hyrax GitHub App. Install it on your GitHub organization or personal account, and choose which repositories it can access, all or specific ones. You can change that selection in GitHub at any time. The App is for repository access, not for signing in. Private and public repositories both work this way, with fixes and automatic PR review.
  • A public repository by URL. Paste the address of any public GitHub repository, without installing the App. These repositories are read-only: see Public repos by URL below.

Pick the repository and its branch, and add it.

3. What happens on its own​

Adding a repository starts two things, with nothing more to set up:

  1. Discovery. Hyrax reads the repository for the first time and profiles how it works: its architecture, conventions and how-to knowledge. The repository page says "Hyrax is reading this repository for the first time. Audits unlock when it's done." If discovery hasn't run, start it with Run discovery on the repository page. See Discovery & AI agent context.
  2. PR review. Review is on for every repository you connect through the GitHub App, so Hyrax reviews each new pull request as it's opened. You can turn it off per repository. See PR review.

No audit runs on its own. Your first audit is something you choose to start once discovery finishes.

4. Run your first audit​

Once discovery is done, start an audit in either of these places:

  • Activity, with the Audits kind selected: choose Run audit, pick the repository, and pick a Depth: Standard (the usual audit, faster and cheaper) or Full (every audit tool, slower, and costs more).
  • The repository's page: the audit button in its header runs a Standard audit, and its menu offers a Full one.

When the audit finishes, the person who started it gets a notification. See Running audits & fixes for the details.

5. Read and act on what it found​

Open Code health in the rail. It lists your open findings, starting with the Critical and High ones that still need a decision. Each finding says what is wrong, why it matters, and the file and lines it touches, with a stable ref like HYRAX-42.

For each finding you can:

  • Fix it: Hyrax makes the change and opens a pull request for you to review and merge. See Fixes.
  • File it as an issue, from a project's Code health page, to track the work in that project. See Issues.
  • Dismiss it if it doesn't apply. Your triage is remembered when audits run again.

Public repos by URL​

A public repository added by URL runs read-only. Audits and discovery work, and a review can be started through the API with its findings shown in Hyrax, but nothing posts to GitHub. Fix writes back to your repository, so it needs the App. Installing the App later doesn't change a repository you added by URL: to run Fix, remove the repository and add it again with the App installed. Adding public repositories by URL is available on every plan. See Public & private repositories.

Next steps​