ironbee verify job it starts, reports to a project in the IronBee Console. You don’t create that project by hand: the CLI works out its name from your repository.
The project name
The CLI walks up from the directory you work in to the enclosing git repository, and takes the name from:- the repository name in the
originremote’s URL - otherwise, the first remote’s repository name
- otherwise, the name of the repository’s folder
/ as -. acme/shop is shop, and acme/platform/backend in a subgroup is platform-backend.
Worktrees report under the main repository’s name, not the worktree folder’s. Parallel agents that work in separate worktrees land in one project. A submodule is its own project, named from its own remote.
Repository projects and CLI projects
A project in the console belongs to a provider: GitHub, GitLab, Bitbucket, Vercel, Netlify, or the CLI. The same name under two providers makes two projects. When your checkout’s remote is on github.com, and the derived name equals the repository’s name, the CLI claims the repository’s GitHub project. Your sessions and jobs then report to the same project as the GitHub App and the GitHub Action runs for that repository. If that project doesn’t exist yet, it’s created. The claim works with HTTPS and SSH remotes, includingssh.github.com (SSH over port 443) and git+ssh:// or ssh+git:// URLs.
When the remote is on gitlab.com, the CLI claims the project’s GitLab project the same way. The derived name must equal the project’s last path segment, or its name as above. The claim works with HTTPS and SSH remotes, including altssh.gitlab.com (SSH over port 443).
When the remote is on bitbucket.org, the CLI claims the repository’s Bitbucket project the same way. The derived name must equal the repository’s slug. The claim works with HTTPS and SSH remotes, including altssh.bitbucket.org (SSH over port 443).
For an ironbee verify job, the claim follows the repository the run is bound to: the remote your branch is pushed to. A job on a branch pushed to a fork, or to another host, reports to that repository’s project when its name matches, and claims none otherwise.
In every other case, the CLI reports to a CLI project with the derived name:
- a remote on another host, a self-managed GitLab server or Bitbucket Data Center or Server included
- no remote
- a name that doesn’t match the repository
Before CLI 0.45, a github.com checkout reported to a CLI project with the repository’s name. After upgrading, new sessions and jobs report to the repository’s GitHub project instead. Earlier history stays in the CLI project.
Before CLI 0.49, a gitlab.com checkout reported to a CLI project, and a project in a subgroup was named by its last segment, such as
backend. After upgrading, new sessions and jobs report to the GitLab project under its new name, such as platform-backend, and ${projectName} in your config follows it. Earlier history stays where it was.Before CLI 0.53, a bitbucket.org checkout reported to a CLI project with the repository’s name. After upgrading, new sessions and jobs report to the repository’s Bitbucket project. Earlier history stays in the CLI project.
ironbee verify prints a notice so you can move them.
Naming the project yourself
--project <name> on ironbee verify run web or ironbee verify run api names the project explicitly, and doesn’t claim a repository’s project. In GitHub Actions, GitLab CI or Bitbucket Pipelines, the job reports to the GitHub, GitLab or Bitbucket project with that name, which is created if it doesn’t exist yet. On a checkout whose remote is on another host than the CI’s, pass --no-repo too. Anywhere else, it reports to a CLI project with that name.
What is sent
For a github.com checkout, every event the CLI sends carries the repository’sowner/repo, so the console can file it under the GitHub project. For a gitlab.com checkout, it carries the project’s full path, and for a bitbucket.org checkout, the repository’s workspace/repo_slug. This includes the events of the devtools server. It happens whether or not issue-tracker and VCS linking is enabled. The only way to stop it is to suspend the Collector with collector.enable: false, which stops sending anything at all. See Privacy mode.
Local bookkeeping
The CLI also keeps a local inventory of the projects where you installed IronBee. These entries aren’t console projects:~/.ironbee/projects.jsonlists them.~/.ironbee/projects/<token>/holds each one’s runtime data.