Skip to content

Commit

Permalink
PA-12267 Standardize Readme (#9)
Browse files Browse the repository at this point in the history
  • Loading branch information
@SOOS-JAlvarez
SOOS-JAlvarez committed Dec 20, 2023
1 parent 9edc609 commit 3a8850a
Showing 1 changed file with 11 additions and 16 deletions.
27 changes: 11 additions & 16 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

SOOS is an independent software security company, located in Winooski, VT USA, building security software for your team. [SOOS, Software security, simplified](https://soos.io).

Use SOOS to scan your software for [vulnerabilities](https://app.soos.io/research/vulnerabilities) and [open source license](https://app.soos.io/research/licenses) issues with [SOOS Core SCA](https://soos.io/products/sca). [Generate SBOMs](https://kb.soos.io/help/generating-a-software-bill-of-materials-sbom). Govern your open source dependencies. Run the [SOOS DAST vulnerability scanner](https://soos.io/products/dast) against your web apps or APIs.
Use SOOS to scan your software for [vulnerabilities](https://app.soos.io/research/vulnerabilities) and [open source license](https://app.soos.io/research/licenses) issues with [SOOS Core SCA](https://soos.io/products/sca). [Generate and ingest SBOMs](https://soos.io/products/sbom-manager). [Export reports](https://kb.soos.io/help/soos-reports-for-export) to industry standards. Govern your open source dependencies. Run the [SOOS DAST vulnerability scanner](https://soos.io/products/dast) against your web apps or APIs. [Scan your Docker containers](https://soos.io/products/containers) for vulnerabilities. Check your source code for issues with [SAST Analysis](https://soos.io/products/sast).

[Demo SOOS](https://app.soos.io/demo) or [Register for a Free Trial](https://app.soos.io/register).

Expand All @@ -23,28 +23,23 @@ run `npm install --prefix ./soos @soos-io/soos-sast`

Then run from the same terminal `node ./soos/node_modules/@soos-io/soos-sast/bin/index.js`

## Parameters
## Client Parameters


| Argument | Default | Description |
| ------------------------ | ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| `--apiKey` | N/A | SOOS API Key - get yours from [SOOS Integration](https://app.soos.io/integrate/sast). Uses `SOOS_API_KEY` env value if present. |
| `--apiURL` | N/A | SOOS API URL - Intended for internal use only, do not modify. |
| `--appVersion` | N/A | App Version - Intended for internal use only. |
| `--branchName` | `null` | The name of the branch from the SCM System. |
| `--branchURI` | `null` | The URI to the branch from the SCM System. |
| `--buildURI` | `null` | URI to CI build info. |
| `--buildVersion` | `null` | Version of application build artifacts. |
| `--clientId` | N/A | SOOS Client ID - get yours from [SOOS Integration](https://app.soos.io/integrate/sast). Uses `SOOS_API_CLIENT` env vaue if present. |
| `--commitHash` | `null` | The commit hash value from the SCM System. |
| `--apiKey` | | SOOS API Key - get yours from [SOOS Integration](https://app.soos.io/integrate/sast). Uses `SOOS_API_KEY` env value if present. |
| `--branchName` | | The name of the branch from the SCM System. |
| `--branchURI` | | The URI to the branch from the SCM System. |
| `--buildURI` | | URI to CI build info. |
| `--buildVersion` | | Version of application build artifacts. |
| `--clientId` | | SOOS Client ID - get yours from [SOOS Integration](https://app.soos.io/integrate/sast). Uses `SOOS_API_CLIENT` env value if present. |
| `--commitHash` | | The commit hash value from the SCM System. |
| `--directoriesToExclude` | `**/node_modules/**, "**/bin/**", "**/obj/**", "**/lib/**` | Listing of directories or patterns to exclude from the search for manifest files. eg: **bin/start/**, **/start/** |
| `--filesToExclude` | None | Listing of files or patterns to exclude from the search for manifest files. eg: **/req**.txt/, **/requirements.txt |
| `--integrationName` | N/A | Integration Name - Intended for internal use only. |
| `--integrationType` | N/A | Integration Type - Intended for internal use only. |
| `--logLevel` | `INFO` | Minimum level to show logs: PASS, IGNORE, INFO, WARN or FAIL. |
| `--onFailure` | `continue_on_failure` | Action to perform when the scan fails. Options: fail_the_build, continue_on_failure. |
| `--operatingEnvironment` | `null` | Set Operating environment for information purposes only. |
| `--projectName` | N/A | Project Name - this is what will be displayed in the SOOS app. |
| `--scriptVersion` | N/A | Script Version - Intended for internal use only. |
| `--operatingEnvironment` | | Set Operating environment for information purposes only. |
| `--projectName` | | Project Name - this is what will be displayed in the SOOS app. |
| `--sourceCodePath` | `process.cwd()` | Root path to begin recursive search for Sarif files. |
| `--verbose` | `false` | Enable verbose logging. |

0 comments on commit 3a8850a

Please sign in to comment.