From 7ce0ae3819a278960568ebcd9a64dbed1357066b Mon Sep 17 00:00:00 2001 From: Bar Belity Date: Sun, 27 Oct 2024 21:12:25 +0000 Subject: [PATCH] GITBOOK-147: Update JFrog CLI git cc command mandatory flags --- .../count-contributing-developers.md | 22 +++++++++---------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/jfrog-applications/jfrog-applications/jfrog-cli/cli-for-jfrog-security/count-contributing-developers.md b/jfrog-applications/jfrog-applications/jfrog-cli/cli-for-jfrog-security/count-contributing-developers.md index 182ea6c..2b3785e 100644 --- a/jfrog-applications/jfrog-applications/jfrog-cli/cli-for-jfrog-security/count-contributing-developers.md +++ b/jfrog-applications/jfrog-applications/jfrog-cli/cli-for-jfrog-security/count-contributing-developers.md @@ -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 |

(optional) The type of SCM to use for the analysis.

Supported Values: github, gitlab, bitbucket Example: --scm-type=github

| -| --scm-api-url |

(optional) The base URL of the SCM system's API endpoint.

Format: The full URL, including the protocol Example: --scm-api-url=https://api.github.com

| -| --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 |

(optional)

Enables verbose output, providing more detailed information.

| +| Command Option | Description | +| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| --scm-type |

[Mandatory]

The type of SCM to use for the analysis.

Supported Values: github, gitlab, bitbucket Example: --scm-type=github

| +| --scm-api-url |

[Mandatory]

The base URL of the SCM system's API endpoint.

Format: The full URL, including the protocol Example: --scm-api-url=https://api.github.com

| +| --token |

[Mandatory]

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 |

[Mandatory]

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 |

[Optional]

Enables verbose output, providing more detailed information.

| #### Example Commands