diff --git a/README.md b/README.md index eba71e6..f15021c 100644 --- a/README.md +++ b/README.md @@ -52,31 +52,31 @@ jobs: ### Inputs -| Variable | Example Value   | Description   | Type | Required | Default | -| ---------------------------- | ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | -------- | ------------- | -| api_token | | Orca API Token used for Authentication | String | Yes | N/A | -| project_key | my-project-key | Project Key name | String | Yes | N/A | -| path | sub-dir | Path to scan | String | Yes | N/A | -| format | json | Format for displaying the results | String | No | cli | -| output | results/ | Output directory for scan results | String | No | N/A | -| no_color | false | Disable color output | Boolean | No | false | -| exit_code | 10 | Exit code for failed execution due to policy violations | Integer | No | 3 | -| control_timeout | 30 | Number of seconds the control has to execute before being canceled | Integer | No | 60 | -| silent | false | Disable logs and warnings output | Boolean | No | false | -| console_output | json | Prints results to console in the provided format (only when --output is provided) | String | No | cli | -| config | config.json | path to configuration file (json, yaml or toml) | String | No | N/A | -| show_annotations | true | show github annotations on pull requests | Boolean | No | true | -| exceptions_filepath | n/a | exceptions YAML filepath. (File should be mounted) | String | No | false | -| hide_vulnerabilities | n/a | do not show detailed view of the vulnerabilities findings | Boolean | No | false | -| show_failed_issues_only | n/a | show only failed issues | Boolean | No | false | -| display_name | custom-display-name | Scan log display name (on Orca platform) | String | No | N/A | -| hide_skipped_vulnerabilities | false | Filter out skipped vulnerabilities from result | Boolean | No | false | -| exclude_paths | ./notToBeScanned/,example.tf | List of paths to be excluded from scan (comma-separated) | String | No | N/A | -| file_patterns | pip:requirements-.\*\\.txt | Use this flag when you have dependency files with non-standard names that the scanner wouldn't recognize by default. Indicate which analyzer (e.g., Python, Docker, npm) to use for a specific file pattern. Format: \:\ . Example: pip:requirements-.\*\\.txt | String | No | N/A | -| dependency_tree | false | Show dependency origin tree of vulnerable packages | Boolean | No | false | -| security_checks | license | List of security issues to detect (comma-separated) | String | No | vulns,license | -| debug | true | Debug mode | Boolean | No | false | -| log_path | results/ | The directory path to specify where the logs should be written to on debug mode. | String | No | working dir | +| Variable | Example Value   | Description   | Type | Required | Default | +| ---------------------------- | ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | -------- | ----------------------- | +| api_token | | Orca API Token used for Authentication | String | Yes | N/A | +| project_key | my-project-key | Project Key name | String | Yes | N/A | +| path | sub-dir | Path to scan | String | Yes | N/A | +| format | json | Format for displaying the results | String | No | cli | +| output | results/ | Output directory for scan results | String | No | N/A | +| no_color | false | Disable color output | Boolean | No | false | +| exit_code | 10 | Exit code for failed execution due to policy violations | Integer | No | 3 | +| control_timeout | 30 | Number of seconds the control has to execute before being canceled | Integer | No | 60 | +| silent | false | Disable logs and warnings output | Boolean | No | false | +| console_output | json | Prints results to console in the provided format (only when --output is provided) | String | No | cli | +| config | config.json | path to configuration file (json, yaml or toml) | String | No | N/A | +| show_annotations | true | show github annotations on pull requests | Boolean | No | true | +| exceptions_filepath | n/a | exceptions YAML filepath. (File should be mounted) | String | No | false | +| hide_vulnerabilities | n/a | do not show detailed view of the vulnerabilities findings | Boolean | No | false | +| show_failed_issues_only | n/a | show only failed issues | Boolean | No | false | +| display_name | custom-display-name | Scan log display name (on Orca platform) | String | No | N/A | +| hide_skipped_vulnerabilities | false | Filter out skipped vulnerabilities from result | Boolean | No | false | +| exclude_paths | ./notToBeScanned/,example.tf | List of paths to be excluded from scan (comma-separated) | String | No | N/A | +| file_patterns | pip:requirements-.\*\\.txt | Use this flag when you have dependency files with non-standard names that the scanner wouldn't recognize by default. Indicate which analyzer (e.g., Python, Docker, npm) to use for a specific file pattern. Format: \:\ . Example: pip:requirements-.\*\\.txt | String | No | N/A | +| dependency_tree | false | Show dependency origin tree of vulnerable packages | Boolean | No | false | +| security_checks | license | List of security issues to detect (comma-separated) | String | No | vulns,license,malicious | +| debug | true | Debug mode | Boolean | No | false | +| log_path | results/ | The directory path to specify where the logs should be written to on debug mode. | String | No | working dir | ## Annotations