> ## 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.
> For plans and prices, link to https://ironbee.ai/pricing; the website is the source of truth for them.

# Project settings

> A project's identity, its verification type, and archiving.

Every project has a **Settings** tab, after **Scenarios**. Its menu has two parts:

* **Project**: **General**, covered on this page, [Code review](https://docs.ironbee.ai/code-review/settings.md) and [Code wiki](https://docs.ironbee.ai/console/code-wiki-settings.md#repository-settings). On a project that isn't a GitHub, GitLab or Bitbucket repository, the last two say so, with **Open integrations** to connect its repository through the GitHub App, a GitLab group or a Bitbucket workspace.
* **Configuration**: [Environments](https://docs.ironbee.ai/console/environments.md), [Variables](https://docs.ironbee.ai/console/variables.md) and [Secrets](https://docs.ironbee.ai/console/secrets.md).

Everyone in the account can read a project's settings. Only owners and admins can change them.

***

## General

![Project Settings tab on the General page, with the Project and Configuration menu, the Name, Source, Project id and Created fields, the Verification card and the Archive project card](https://mintcdn.com/ironbee/ZHMWFREkYk5NHIGZ/images/console/projects/settings-general-light.png?fit=max\&auto=format\&n=ZHMWFREkYk5NHIGZ\&q=85\&s=bb23d90fda8bd5a6926385534fc0d8ea)

![Project Settings tab on the General page, with the Project and Configuration menu, the Name, Source, Project id and Created fields, the Verification card and the Archive project card](https://mintcdn.com/ironbee/ZHMWFREkYk5NHIGZ/images/console/projects/settings-general-dark.png?fit=max\&auto=format\&n=ZHMWFREkYk5NHIGZ\&q=85\&s=9c3fbf0dfca2001f840bc6791d0b92b3)

The **General** page shows how the project is identified:

| Field | What it shows |
| - | - |
| **Name** | The project's name: the repository, Vercel project, Netlify site or CLI name. A GitLab repository is named by its path after the group, with `/` as `-`, such as `platform-backend`, and a Bitbucket repository by its slug |
| **Source** | Where the project comes from: GitHub, GitLab, Bitbucket, Vercel, Netlify or CLI |
| **Project id** | The project's id, with a copy button |
| **Created** | When the project was created |

***

## Verification type

The **Verification** card sets what a deployment of this project starts:

* **Web** opens the deployment in a browser and exercises it as a user would.
* **API** calls the deployment over HTTP and checks the responses against its contract.
* **None** starts nothing on a deployment until a type is set here.

Pick one and click **Save**. The change takes effect on the next deployment. A GitHub, GitLab or Bitbucket repository starts with **None**, and so does a Vercel project or Netlify site enabled with **None**.

> [!NOTE]
>
> * The type applies to deployments from Vercel and Netlify. Runs started from the GitHub Action, the GitLab component, the Bitbucket Pipe, the API or the CLI name their own type, so on a CLI project the selection has no effect.
> * If a project is **Not active**, the card says it isn't verified, and the type can't be changed. Click **Open Vercel integration** (or the Netlify, GitHub, GitLab or Bitbucket one) to enable it again. A GitHub repository also comes back when you add it to the App's repositories on GitHub again.

***

## Archive a project

Archiving takes a project out of use without deleting anything. Projects are never deleted.

To archive, an owner or admin opens **Settings > General**, clicks **Archive** under **Archive project**, types the project's name to confirm, and clicks **Archive project**.

![Archive project dialog with a Data arrived 2h ago warning, the four consequences, and a field to type the project name to confirm](https://mintcdn.com/ironbee/Ga5ZIxAT3IUrLTxO/images/console/projects/archive-dialog-light.png?fit=max\&auto=format\&n=Ga5ZIxAT3IUrLTxO\&q=85\&s=929a36f444b0bd5e50c4cb55f9600030)

![Archive project dialog with a Data arrived 2h ago warning, the four consequences, and a field to type the project name to confirm](https://mintcdn.com/ironbee/Ga5ZIxAT3IUrLTxO/images/console/projects/archive-dialog-dark.png?fit=max\&auto=format\&n=Ga5ZIxAT3IUrLTxO\&q=85\&s=099fd95164d5cafdc5ac71fc0e759a43)

The dialog lists what changes:

* **Triggers stop.** Deployments no longer start runs. For a CLI project, nothing starts on its own anyway.
* **New data is refused.** Sessions and runs reporting to the project are dropped until you unarchive it. That includes teammates on an older CLI, a fork of the repository, or a CI job.
* **History stays.** Verifications, findings and evidence remain readable.
* **Reversible.** Unarchiving brings the project back as it was. Data refused in the meantime doesn't come back.

If data reached the project recently, the dialog opens with a **Data arrived** warning that says when, because anything still reporting to the project is dropped once it's archived.

An archived project is read-only and hidden from the **Projects** page and the pickers.

### Unarchive a project

Owners and admins open **Settings > Archived projects** from the account settings. The list shows each archived project with its **Project**, **Source** and when it was **Archived**. Click **Unarchive** and confirm with **Unarchive project**. The project returns to the list and its triggers start again.

![Archived projects page listing two archived projects with their Project, Source and Archived columns and an Unarchive button on each row](https://mintcdn.com/ironbee/Ga5ZIxAT3IUrLTxO/images/console/projects/archived-projects-light.png?fit=max\&auto=format\&n=Ga5ZIxAT3IUrLTxO\&q=85\&s=670d6f930bdcc99fcca06aca86289b87)

![Archived projects page listing two archived projects with their Project, Source and Archived columns and an Unarchive button on each row](https://mintcdn.com/ironbee/Ga5ZIxAT3IUrLTxO/images/console/projects/archived-projects-dark.png?fit=max\&auto=format\&n=Ga5ZIxAT3IUrLTxO\&q=85\&s=1b155ee5edd290c3f9fb7f89347514db)

***

## What's next?

> [card] [Environments](https://docs.ironbee.ai/console/environments.md)
>
> The deployments this project is verified against.

> [card] [Secrets](https://docs.ironbee.ai/console/secrets.md)
>
> Credentials a run can use without seeing them.


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