The SOOS SCM Audit script should be used to determine the number of contributing developers in your organization.
You may choose to install the package globally or locally, if you are unsure, you can find out more about installing globally on npm.
run npm i -g @soos-io/soos-scm-audit@latest
run npm install --prefix ./soos @soos-io/soos-scm-audit
NOTE: you can find values for the --apiKey
and --clientId
at app.soos.io.
-
Generate a GitHub Public Access Token (PAT) for your organization and ensure that it has the full
repo
permission set. -
Plug in the values for
--apiKey
,--clientId
,--secret
, and--organizationName
and run the script.
soos-scm-audit --apiKey=<API_KEY> --clientId=<CLIENT_ID> --scmType=GitHub --secret=<GITHUB_PAT> --organizationName="<GITHUB_ORG_NAME>"
node ./soos/node_modules/@soos-io/soos-scm-audit/bin/index.js --apiKey=<API_KEY> --clientId=<CLIENT_ID> --scmType=GitHub --secret=<GITHUB_PAT> --organizationName="<GITHUB_ORG_NAME>"
-
Generate an App Password for your organization and ensure that it has the Read
Repositories
permission set. -
Plug in the values for
--apiKey
,--clientId
,--secret
, and--workspace
, and--username
and run the script.
soos-scm-audit --apiKey=<API_KEY> --clientId=<CLIENT_ID> --scmType=BitbucketCloud --secret=<APP_PASSWORD> --workspace="<BITBUCKET_WORKSPACE>" --username="<BITBUCKET_USERNAME>"
node ./soos/node_modules/@soos-io/soos-scm-audit/bin/index.js --apiKey=<API_KEY> --clientId=<CLIENT_ID> --scmType=BitbucketCloud --secret=<APP_PASSWORD> --workspace="<BITBUCKET_WORKSPACE>" --username="<BITBUCKET_USERNAME>"
General Parameters | Default | Description |
---|---|---|
--apiKey | SOOS API Key - get yours from SOOS Integration. Uses SOOS_API_KEY env value if present. | |
--clientId | SOOS Client ID - get yours from SOOS Integration. Uses SOOS_API_CLIENT env value if present. | |
--logLevel | Minimum level to show logs: DEBUG, INFO, WARN, FAIL, ERROR. | |
--saveResults | Save results to file. | |
--scmType | Scm Type to use for the audit. Options: GitHub, BitBucketCloud | |
--verbose | false | Enable verbose logging. |
BitBucket Cloud Parameters | Default | Description |
---|---|---|
--username | Username where the App password was generated for BitBucketCloud. | |
--secret | Secret to use for API calls. It should be a App Password | |
--workspace | Workspace name to run audit for BitBucketCloud. |
GitHub Parameters | Default | Description |
---|---|---|
--organizationName | Organization name to run audit for GitHub. | |
--secret | Secret to use for API calls. It should be a GPAT |