- code reviews of the pull requests in a GitHub or Bitbucket repository, or the merge requests in a GitLab one
- verification runs, which IronBee executes on its own infrastructure for your deployments, pull requests and merge requests
- sessions, which your AI coding agent records with the IronBee CLI
Account
Your account is the workspace your team shares. It holds your projects, integrations and settings. Everyone in it has a role: Owner, Admin, Member or Billing Admin. See Roles and permissions.Credits
Code reviews, verification runs and code security scans spend credits from one pool the whole team shares. The plan sets the monthly credits, which reset on the account’s own date each month. On Free and Team, owners and billing admins can also buy credits, which are spent after the monthly ones and stay valid for 12 months. The code wiki and the CLI’s verification cycles use none. See Credit usage and Pricing.Project
A project is what IronBee verifies:- a GitHub repository
- a GitLab repository
- a Bitbucket repository
- a Vercel project
- a Netlify site
- a CLI project: a name your IronBee CLI reports under
- Web: open the deployment in a browser and exercise it as a user would.
- API: call the deployment over HTTP and check the responses against its contract.
Code review
A code review is IronBee’s review of a pull request in a GitHub repository the IronBee GitHub App covers, of a merge request in a repository of a connected GitLab group, or of a pull request in a repository of a connected Bitbucket workspace. It runs when the pull request opens or gets a push, or when you ask for one, and posts its comments, a summary and the IronBee review check on the pull request. On GitLab, the check is a pipeline status, and on Bitbucket a build status.- A finding is one problem a review reports, with a severity (Critical, High, Medium or Low) and a category. A later review marks it addressed once a push fixes it. A failed verification run on IronBee reports findings the same way, and posts them on the pull request with suggested fixes.
- A rule tells the review what must or must not happen in your code, and can raise a finding. A memory tells it what is true in a part of the code.
Code wiki
The code wiki is a set of pages IronBee writes about a GitHub, GitLab or Bitbucket repository from its default branch: an overview, where to start, the architecture, and one page for each area of the code. It’s written again as pull requests merge, and every claim links to the lines it comes from. It’s on the project’s Code wiki tab. See Code wiki of a repository.Code security
Code security is a scheduled scan of the default branch of a GitHub, GitLab or Bitbucket repository for security problems. It’s off until an owner or an admin turns it on for a repository, and only owners and admins see it.- A scan reads the code. The first scan is a full scan, and a later scheduled scan reads what changed since the last one.
- A record is one problem a scan found. A confirmed finding is one the scan reproduced by running the code, and has a severity. A lead to validate is one it could not prove yet, and has no severity.
- A decision is what your team does with a record: Open, Accepted, Fixed elsewhere or Not an issue.
- One scan runs at a time in an account; the scan that has waited longest goes next.
Verification run
A verification run is one verification of a change: a preview deployment, a push, a pull request, or a run you start yourself. An agent reads what changed, exercises it against your running app, and records a result with the evidence behind it. Every run has:- A trigger, what started it: Vercel, Netlify, GitHub Actions, GitLab CI, Bitbucket Pipelines, API, CLI or Console.
- A status, where it is: Created, Queued, Starting, Running, Completed, Failed, Cancelled.
- A result, what it concluded: Pass, Fail, Not applicable (the change left nothing to verify), Soft fail or Unknown.
- The source it verified, for runs tied to a GitHub, GitLab or Bitbucket repository: repository, branch, commit and pull request.
Environment, variable and secret
An environment is one deployment of a project that runs are verified against, such aspreview or staging. Integrations create environments automatically. Its URL, OpenAPI document and Domain properties tell the run about the deployment. See Environments.
Variables are plain values a run is told outright. See Variables.
Secrets are credentials a run can use without seeing them: sign-in credentials, tokens, headers, a deployment protection bypass. They’re written once and never shown again. See Secrets.
Variables and secrets apply to all environments, or to one.
Scenario
A scenario is a flow written in plain words, such as “sign in, add a product to the cart and check the total”, saved in a project. You write it once in the console and run it against one of the project’s environments whenever you need:- Setup prepares the run, Main decides the verdict, and Teardown cleans up.
- Each action is an Act, an Assert, an Extract or a Wait. A scenario can import another one to reuse it.
- Each run is a verification run. Its result is Soft fail when only a soft assert failed.
Evidence
The evidence of a run is everything it recorded:- the recording and screenshots
- the actions it took
- the network requests
- the traces
- the logs
Session
A session is one working session of your AI coding agent with the IronBee CLI, from start to finish. It records what the agent did: its activities, its verification cycles, and their verdicts. An activity is one agent turn: from your prompt to the moment the agent stops.Verification cycle
A verification cycle is one pass of verification inside a session. The CLI verifies through six platforms:
Every enabled platform that matches the changed files takes part in the same cycle. Turn platforms on or off with
ironbee <platform> enable|disable. See Verification.
In the console, CLI cycles appear among the project’s verification runs with the CLI trigger.
Verdict
A verdict is the agent’s assessment of whether its change works:status:pass,fail, ornot_applicablewhen the change has nothing to verifychecks: what the agent confirmed, such as “form submits successfully”issues: what went wrong. On a pass they’re advisory; on a fail they must be fixedfixes: what was changed to resolve earlier issues
Fix
A fix is a code change the agent makes after a failed verification. The agent then verifies again, up to a retry limit. The GitHub Action, the GitLab component and the Bitbucket Pipe can fix findings too, and commit the fix for you.Verification modes
The CLI runs in one of three modes:
See Verification modes.
Config files
The CLI reads its config from three layers, deep-merged (project-local wins over project, which wins over global):
The
IRONBEE_SERVICE_API_KEY environment variable overrides service.apiKey from any config file. See Configuration.