Add SCM Token Mode

Overview

Mobb supports on-premise repositories as explained in the system requirements. However, to analyze an on-premise repository, the SCM token must be added to your Mobb account to grant Mobb access to read and write to your repository (To run analysis and commit fixes). This task can either be done on the Mobb UI as explained here, or via the Mobb CLI.

To add the SCM token via the CLI, you can use the add-scm-token mode. To learn more about what's required for this mode, you can run the following command:

npx @mobb.ai/cli@latest add-scm-token --help

Output

mobbdev add-scm-token

Add your SCM (Github, Gitlab, Azure DevOps) token to Mobb to enable automated fixes.

Options:
  --scm-type       SCM type                                 [required] [choices: "GitHub", "GitLab", "Ado", "Bitbucket"]
  --url            URL of the repository (used in GitHub, GitLab, Ado, Bitbucket)                     [string] [required]
  --token          SCM API token                                                                     [string] [required]
  --organization   Organization name in SCM (used in Azure DevOps)                                              [string]
  --refresh-token  SCM refresh token (used in GitLab)                                                           [string]
  --api-key        Mobb authentication api-key                                                                  [string]
  --ci             Run in CI mode, prompts and browser will not be opened                     [boolean] [default: false]
  --help           Show help                                                                                   [boolean]

Examples:
  npx mobbdev@latest add-scm-token --scm-type Ado          Add your SCM (Azure DevOps, Bitbucket, GitGub, GitLab) token
  --url                                                    to Mobb to enable automated fixes.
  https://dev.azure.com/adoorg/test/_git/repo --token
  abcdef0123456 --organization myOrg

Parameters:

--scm-type Description: SCM type [required] [choices: "GitHub", "GitLab", "Ado", "Bitbucket"]

--url Description: URL of the repository (used in GitHub, GitLab, Ado, Bitbucket) [string] [required]

--token Description: SCM API token [string] [required]

--organization Description: Organization name in SCM (used in Azure DevOps) [string]

--refresh-token Description: SCM refresh token (used in GitLab) [string]

--api-key Description: Mobb authentication api-key [string]

--ci Description: Run in CI mode, prompts and browser will not be opened [boolean] [default: false]

--help Description: Show help [boolean]

Example

npx @mobb.ai/cli@latest add-scm-token --scm-type Ado --url https://dev.azure.com/adoorg/test/_git/repo --token abcdef0123456 --organization myOrg

Because --token puts a secret on the command line, prefer passing it from a CI secret or an environment variable rather than typing it literally, and be aware that shell history may retain it.