Skip to main content

Step 1: Create your account

Go to console.ironbee.ai and sign up with Google, GitHub, or your work email. The first time you sign in, Name your account, for example after your company, and click Continue. See Sign in and team access.

Step 2: Connect your repositories

When you create a new account, the console opens Set up IronBee. It has three steps: Connect, Pick repositories and First review. The first one, Connect your repositories, offers three cards: GitHub, GitLab and Bitbucket.
1

Connect

GitHub: click Install on GitHub. GitHub opens in a new window, where you pick the organization or account and the repositories IronBee can see. The step reads Finish on GitHub and moves on by itself once the App is installed.
  • If the window doesn’t open, or you’d rather stay in one tab, click Continue in this tab instead. GitHub brings you back to this step.
  • If you can’t install apps in your organization, pick the organization anyway. GitHub sends a request to its owners, and the step shows Request sent to your organization owners. It moves on by itself when one of them approves. Meanwhile, Copy link copies the install link to send to an owner, and Open GitHub lets you install on an account you own instead.
GitLab: you need the Owner role on a top-level group on gitlab.com. Click Connect GitLab, authorize IronBee on GitLab, and pick the group. IronBee creates a service account in the group to work through, and brings you back to the next step. See GitLab.Bitbucket: you need to be an admin of the workspace on bitbucket.org. Click Install on Bitbucket and follow the steps it shows: install IronBee’s app from Atlassian’s installation page, then, in Bitbucket, open Workspace settings > Forge Apps > IronBee and click Connect to IronBee. Atlassian doesn’t bring you back, so the step reads Finish on Bitbucket and moves on by itself once you confirm the workspace in IronBee. See Bitbucket.The Connect your repositories step of Set up IronBee: the GitHub card picked, next to the GitLab and Bitbucket cards, what IronBee does on GitHub, and the Set up later and Install on GitHub buttonsThe Connect your repositories step of Set up IronBee: the GitHub card picked, next to the GitLab and Bitbucket cards, what IronBee does on GitHub, and the Set up later and Install on GitHub buttons
2

Pick repositories

GitHub: every repository you shared with the App is already an IronBee project. Under Pick repositories to connect, the ticks set which of them also have code review on. Click Connect N repositories. Missing a repository? Click Change access on GitHub, share it with the App, then click Refresh.GitLab and Bitbucket: a group or a workspace makes no repository a project until you pick. Choose All repositories, which includes the ones added later, or Only selected repositories, and tick them. Each repository you pick is connected as a project and gets everything IronBee does for a repository, reviews included. Click Connect N repositories. Missing a repository? Click Sync now.The Pick repositories to connect step of Set up IronBee: Installed on acme, 5 repositories shared, with Change access on GitHub, the ticked repositories, Missing a repository? with Change access on GitHub and Refresh, and the Connect 5 repositories buttonThe Pick repositories to connect step of Set up IronBee: Installed on acme, 5 repositories shared, with Change access on GitHub, the ticked repositories, Missing a repository? with Change access on GitHub and Refresh, and the Connect 5 repositories button
3

First review

Under Pick a pull request for your first review, or Pick a merge request for your first review on GitLab, pick an open one and click Review #N. Drafts are marked Draft, skipped.The Pick a pull request for your first review step: three open pull requests with their repository and author, the draft marked Draft, skipped, the credits left this month, and the Back and Review #128 buttonsThe Pick a pull request for your first review step: three open pull requests with their repository and author, the draft marked Draft, skipped, the credits left this month, and the Back and Review #128 buttonsThe step follows the review: Queued, Starting the reviewer, Reading the changes, Posting the review on GitHub (or on GitLab, on Bitbucket). You can Close it at any time; the review keeps going and shows up on the pull request. When Your first review is ready, click Open the review to read it in the console, or View on GitHub (View on GitLab, View on Bitbucket).No open pull request yet? Click Finish setup. IronBee reviews the next one on its own.The Your first review is ready step: the reviewed pull request with its High, Medium and Low finding counts, its top finding, View on GitHub and Open the reviewThe Your first review is ready step: the reviewed pull request with its High, Medium and Low finding counts, its top finding, View on GitHub and Open the review
A review uses credits, by the size of the change. The step shows how many your account has left this month. See Pricing. Set up later closes the wizard on any step. To come back, owners and admins open Setup in the top bar and click Connect a provider. Each repository’s code wiki starts at the same time, unless it’s turned off in Code wiki settings. See Code review of pull requests, GitHub App, GitLab and Bitbucket.

Step 3: Add verification

Code review needs only the GitHub App, the GitLab connection or the Bitbucket connection. To also verify your changes, owners and admins open Settings > Getting started. It offers six ways in, and you can connect more than one. Settings, Getting started: the GitHub and GitLab cards with Connect GitHub and Connect GitLab, the Bitbucket card with its workspace connected and Add the Pipe, and the Vercel, Netlify and IronBee CLI cards marked connected, with Manage Settings, Getting started: the GitHub and GitLab cards with Connect GitHub and Connect GitLab, the Bitbucket card with its workspace connected and Add the Pipe, and the Vercel, Netlify and IronBee CLI cards marked connected, with Manage
Verify every push and pull request with the IronBee Action.
  1. On the GitHub card, click Add the Action. If the App isn’t installed yet, click Connect GitHub and install it first.
  2. In the IronBee Action step, pick:
    • the Repository
    • Where it runs: On IronBee or On your GitHub runner
    • On a finding: Report it or Fix it too
  3. Fill in how your app starts, and add the repository secrets the console lists: IRONBEE_API_KEY, plus ANTHROPIC_API_KEY or CLAUDE_CODE_OAUTH_TOKEN when your answers need one. Then click Create the file on GitHub.
  4. Committing the file is a push, and that push starts your first verification run.
On Projects, a GitHub project’s card also offers Install the IronBee Action until its first run, and opens the same steps for that repository. See GitHub Action: Getting started.

Step 4: See your results

Open Projects in the console. A GitHub repository is listed as soon as the App covers it, a GitLab or Bitbucket repository once you pick it, a Vercel project or Netlify site once you enable it, and a CLI project when its first data arrives. Click a project to open its Code review tab, then its Verifications tab:
  • While a run is in progress, you can watch it live.
  • Afterwards, its detail page shows the recording, the actions, the network requests and the result.
The Setup checklist in the top bar tracks your progress: Connect a provider, Your first project appears, A deployment or session arrives and Invite a teammate. Owners and admins see it until every item is done, and Hide until tomorrow hides it for a day.
Use the account API key instead of ironbee login. Owners and admins find it in the console under Settings > Account. Supply it through the environment:
See Authentication for when to use each credential.

What’s next?

How integrations work

Projects, verification types, environments and where results land.

Key concepts

The terms used across the console and the docs.

Environments and secrets

Give runs the credentials to sign in to your app.

CLI configuration

Verify patterns, retry limits and devtools settings.