> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ironbee.ai/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> IronBee (ironbee.ai) is an AI QA engineer: it verifies code changes against the running app and keeps the evidence. It is not related to the IronBee open-source web application firewall.
> The console is at https://console.ironbee.ai.
> Install the CLI with `npm install -g @ironbee-ai/cli`, sign in with `ironbee login`, and set up a project with `ironbee install`.
> In GitHub workflows, use the action as `ironbee-ai/ironbee-action@v1` and pass the `IRONBEE_API_KEY` secret as the `ironbee_api_key` input.
> In GitLab pipelines, include the component `gitlab.com/ironbee-ai/ironbee-gitlab/verify@v1`; it reads the `IRONBEE_API_KEY` CI/CD variable by default.
> In Bitbucket Pipelines, run the pipe `docker://ghcr.io/ironbee-ai/ironbee-bitbucket:v1` and pass `IRONBEE_API_KEY: $IRONBEE_API_KEY` and `BITBUCKET_OAUTH_TOKEN: $BITBUCKET_OAUTH_TOKEN` under its `variables:`.
> Console scenarios (https://docs.ironbee.ai/console/scenarios) and CLI saved scenarios (https://docs.ironbee.ai/cli/guides/scenarios) are separate features.
> Code security (https://docs.ironbee.ai/console/code-security) scans a repository's default branch on a schedule. It is off until an owner or admin turns it on for a repository, and only owners and admins see it.
> For plans and prices, link to https://ironbee.ai/pricing; the website is the source of truth for them.

# Code security settings

> Turn code security on for a repository, and choose a scan's profile, whether it may run the code, how often it's scheduled and which paths it leaves out.

Code security settings decide which repositories are [scanned](https://docs.ironbee.ai/console/code-security.md), how far a scan goes, whether it may run the repository's code and how often it comes. You set them at two levels:

* **The account:** open **Settings > Code security**. Its defaults apply to every repository.
* **One repository:** open the project, go to its **Settings** tab and select **Code security**, or click **Scan settings** on the project's **Code security** tab.

A repository follows the account's defaults until it sets its own value. Only owners and admins see these pages.

***

## Account settings

The account page holds the defaults for every repository: **Profile**, **Execution** and **Scheduled scan**. A repository can set its own on its settings page. When repositories hold their own value of a setting, the setting counts them, such as **2 repositories set their own**.

| Setting | Options | Default |
| - | - | - |
| [**Profile**](#profile) | **Auto**, **Quick**, **Standard**, **Deep** | **Auto** |
| [**Execution**](#execution) | **Off**, **On** | **Off** |
| [**Scheduled scan**](#scheduled-scan) | **Daily**, **Weekly**, **Every two weeks**, **Monthly** | **Weekly** |

There's no account setting that turns code security on. Each repository has its own switch, and it's off until you turn it on.

### Profile

The profile sets how far a scan follows what it finds. A deeper profile reads more, takes longer and costs more.

| Profile | What it does |
| - | - |
| **Auto** | Picks by the repository's size: **Standard** for smaller repositories, **Quick** for larger ones. It never picks **Deep**. The option says where the line is |
| **Quick** | The fastest scan. It follows fewer leads |
| **Standard** | A broader scan that follows more leads |
| **Deep** | The most thorough scan, and the slowest |

On the account page, the profiles are a table with a column for each repository size, which gives the credits of a full scan at that size. **The whole rate card** opens [Usage](https://docs.ironbee.ai/console/usage.md#what-a-job-costs).

### Execution

**Execution** decides whether a scan may run a repository's code to prove what it finds.

* **Off:** the scan reads the code and never runs it. What it finds stays a lead to validate, with no severity.
* **On:** the scan installs the dependencies and runs the code in its sandbox. A finding it reproduces is confirmed and gets a severity. A scan with execution costs more: the option shows by how much.

With execution on, a scan:

* runs install scripts and the repository's own code, inside the sandbox only
* reaches the package registries while it installs. The code it runs has no network beyond itself
* installs Node, Python and Go at the version the repository declares. Other languages are read, not run
* is refused, free, for a checkout larger than 2 GiB. The **Code security** tab then says **Too large to scan with execution**

### Scheduled scan

**Scheduled scan** sets how often each repository's scheduled scan comes: **Daily**, **Weekly**, **Every two weeks** or **Monthly**. A period in which the default branch didn't move scans nothing and costs nothing.

***

## Repository settings

A repository's page is for that repository only. Whatever isn't set there follows the account. **Account defaults** opens the account page.

![The Code security page of a project's settings, with the Scan this repository switch off and the Profile options Auto, Quick, Standard and Deep](https://mintcdn.com/ironbee/c9GGRaLd9hYzdFTv/images/console/code-security/settings-project-light.png?fit=max\&auto=format\&n=c9GGRaLd9hYzdFTv\&q=85\&s=c0b4c41bdc6a3e57b4381f16dcfd9356)

![The Code security page of a project's settings, with the Scan this repository switch off and the Profile options Auto, Quick, Standard and Deep](https://mintcdn.com/ironbee/c9GGRaLd9hYzdFTv/images/console/code-security/settings-project-dark.png?fit=max\&auto=format\&n=c9GGRaLd9hYzdFTv\&q=85\&s=e959f7a4c1762d9bd742f987ee0bac3f)

The page opens with **Scan this repository**:

* **On:** the default branch is scanned on its schedule.
* **Off:** nothing is scanned. The records already found are kept, not shown.

Turning the switch on starts no scan by itself. The next scheduled scan reads the repository, or you can start one with [**Run full scan**](https://docs.ironbee.ai/console/code-security.md#run-a-full-scan).

Under the switch, a line counts the settings this repository follows and the ones it sets itself, such as **3 of 3 settings follow the account, 0 set here.** When the repository sets something, it offers **Reset all to account settings**.

Below it:

* **Profile**, **Execution** and **Scheduled scan**, as in [Account settings](#account-settings). A setting that follows the account reads **Account default**, with **Change for every repository** to open the account page. Change one, and it reads **Set for this repository**, with a link to reset it to the account default.
* **Paths to ignore**, which exists only on a repository's page.

Once a scan has counted the repository, each profile shows its price at this repository's size, in credits: a full scan, then a period with changes. Before that, the page says the price depends on the repository's size, with **See the rate card**.

### Paths to ignore

**Paths to ignore** are files left out of every scan and of the repository's size, which a scan's price is counted from. Type a pattern such as `vendor/**` or `**/*.min.js`, then press Enter or click **Add a pattern**.

A pattern is a glob from the repository root: `*` matches within one path segment and `**` matches across segments. The list takes up to 100 patterns, of up to 500 characters each, with at most 10 `**` in one pattern.

Changing the list makes the next scan a full scan. The page says so, with the full scan's price when the repository's size is known.

***

## Save your changes

Click **Save changes** to save, or **Discard** to drop your changes. **Code security settings saved** confirms it. If the console refuses a value, it says **Some settings were refused**.

A change applies at a repository's next scan. A scan already running keeps the settings it started with.

***

## Who can change settings

Only owners and admins see code security settings, at both levels, and only they change them. A member or a billing admin who opens a settings page's address sees **Only owners and admins see the code security settings.** See [Roles and permissions](https://docs.ironbee.ai/console/roles.md).

An archived project's page is read-only, and says **This project is archived. Unarchive it to change its code security settings.** See [Project settings](https://docs.ironbee.ai/console/project-settings.md).

Code security scans GitHub, GitLab and Bitbucket repositories only. On a Vercel, Netlify or CLI project, the page says **Code security scans GitHub, GitLab and Bitbucket repositories**.

***

## What's next?

> [card] [Code security](https://docs.ironbee.ai/console/code-security.md)
>
> What a scan does, when it runs and what it costs.

> [card] [Usage](https://docs.ironbee.ai/console/usage.md)
>
> The team's credits this month and the rate card.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.