Skip to content

Commit

Permalink
GITBOOK-147: Update JFrog CLI git cc command mandatory flags
Browse files Browse the repository at this point in the history
  • Loading branch information
@barbelity @gitbook-bot
barbelity authored and gitbook-bot committed Oct 27, 2024
1 parent 3406a10 commit 7ce0ae3
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions ...-applications/jfrog-cli/cli-for-jfrog-security/count-contributing-developers.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,17 +34,17 @@ The `git count-contributors` command can be run from the JFrog CLI with the foll
git count-contributors [command options]
```

| Command Option | Description |
| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| --scm-type | <p>(optional) The type of SCM to use for the analysis. </p><p>Supported Values: <code>github, gitlab, bitbucket</code> Example: <code>--scm-type=github</code></p> |
| --scm-api-url | <p>(optional) The base URL of the SCM system's API endpoint. </p><p>Format: The full URL, including the protocol Example: <code>--scm-api-url=https://api.github.com</code></p> |
| --token | (optional) The authentication token required to access the SCM system's API. In the absence of a flag, tokens should be passed in the JF\_GIT\_TOKEN environment variable, or the corresponding environment variables 'JFROG\_CLI\_GITLAB\_TOKEN, JFROG\_CLI\_GITHUB\_TOKEN or JFROG\_CLI\_BITBUCKET\_TOKEN' Example: `--token:your_access_token` |
| --owner | (optional) The owner or organization of the repositories to be analyzed. Format: Depending on the Git provider. On GitHub and GitLab, the owner is typically an individual or an organization, On Bitbucket, the owner can also be a project. In the case of a private instance on Bitbucket, the individual or organization name should be prefixed with '\~'. When using this option without a specific repository name, all repositories will be analyzed at the group/project level. Example: `owner=your-organization` |
| --months | (optional) The number of months to analyze for developer activity. Default: `1` Example: `--months=6` |
| --detailed-summary | (optional) Generates a more detailed summary of the contributors. Default: `false` Example: `--detailed-summary=true` |
| --repo-name | (optional) List of semicolon-separated(;) repositories names to analyze, If not provided all repositories related to the provided owner will be analyzed. Example: --repo-name=repo1;repo2 |
| --input-file | (optional) The path to an input file in YAML format that contains multiple git providers. Example: `--input-file="/Users/path/to/file/input.yaml"` |
| --verbose | <p>(optional) </p><p>Enables verbose output, providing more detailed information.</p> |
| Command Option | Description |
| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| --scm-type | <p>[Mandatory]</p><p>The type of SCM to use for the analysis. </p><p>Supported Values: <code>github, gitlab, bitbucket</code> Example: <code>--scm-type=github</code></p> |
| --scm-api-url | <p>[Mandatory]</p><p>The base URL of the SCM system's API endpoint. </p><p>Format: The full URL, including the protocol Example: <code>--scm-api-url=https://api.github.com</code></p> |
| --token | <p>[Mandatory]</p><p>The authentication token required to access the SCM system's API. In the absence of a flag, tokens should be passed in the JF_GIT_TOKEN environment variable, or the corresponding environment variables 'JFROG_CLI_GITLAB_TOKEN, JFROG_CLI_GITHUB_TOKEN or JFROG_CLI_BITBUCKET_TOKEN' Example: <code>--token:your_access_token</code></p> |
| --owner | <p>[Mandatory]</p><p>The owner or organization of the repositories to be analyzed. Format: Depending on the Git provider. On GitHub and GitLab, the owner is typically an individual or an organization, On Bitbucket, the owner can also be a project. In the case of a private instance on Bitbucket, the individual or organization name should be prefixed with '~'. When using this option without a specific repository name, all repositories will be analyzed at the group/project level. Example: <code>owner=your-organization</code></p> |
| --months | <p>[Optional]</p><p>The number of months to analyze for developer activity. Default: <code>1</code> Example: <code>--months=6</code></p> |
| --detailed-summary | <p>[Optional]</p><p>Generates a more detailed summary of the contributors. Default: <code>false</code> Example: <code>--detailed-summary=true</code></p> |
| --repo-name | <p>[Optional]</p><p>List of semicolon-separated(;) repositories names to analyze, If not provided all repositories related to the provided owner will be analyzed. Example: --repo-name=repo1;repo2</p> |
| --input-file | <p>[Optional]</p><p>The path to an input file in YAML format that contains multiple git providers. Example: <code>--input-file="/Users/path/to/file/input.yaml"</code></p> |
| --verbose | <p>[Optional]</p><p>Enables verbose output, providing more detailed information.</p> |

#### Example Commands <a href="#example-commands" id="example-commands"></a>

Expand Down

0 comments on commit 7ce0ae3

Please sign in to comment.