Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@SOOS-GSteen
SOOS-GSteen committed Dec 21, 2023
1 parent e8edbfe commit e098d98
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,18 +28,18 @@ Then run from the same terminal `node ./soos/node_modules/@soos-io/soos-sast/bin

| Argument | Default | Description |
| ------------------------ | ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| `--apiKey` | | SOOS API Key - get yours from [SOOS Integration](https://app.soos.io/integrate/sast). Uses `SOOS_API_KEY` env value if present. |
| `--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 |
| `--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. |
| `--filesToExclude` | | Listing of files or patterns to exclude from the search for manifest files. eg: **/req**.txt/, **/requirements.txt |
| `--logLevel` | | Minimum level to show logs: DEBUG, INFO, WARN, FAIL, ERROR. |
| `--onFailure` | `continue_on_failure` | Action to perform when the scan fails. Options: fail_the_build, continue_on_failure. |
| `--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. |
| `--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 e098d98

Please sign in to comment.