General parameters of the scan_codebase.py and scan_artifact.py scripts
 |
Correct completion of these scripts is possible only if all required parameters are specified. |
| Parameter | Required parameter | Description | Example |
|---|---|---|---|
--url |
+ | Maverix URL | --url https://hub.demo.maverix.co |
--token |
+ | Maverix authorization token | --token <token> |
--appcode |
+ | Application code in the Maverix database | --appcode dvja |
--tagged-artifact |
– | Artifact tagged as a result of the scan. Required parameter if the corresponding action is added to the security pipeline, otherwise ignored | --tagged-artifact https://nexus.dev.maverix.co/ |
--insecure |
– | It disables security checks (such as checking SSL certificates). By default: enabled | --insecure |
--no-wait |
– | If this parameter is specified, CLI doesn't wait for the scan completion | --no-wait |
--debug |
– | If this parameter is specified, "log level" is DEBUG. By default, "log level" — INFO | --debug |
--error |
– | If this parameter is specified, "log level" is ERROR. By default, "log level" — INFO | --error |
--result-file |
– | It defines the name and location of the JSON file with scan results* | --result-file ./result.json |
--unit |
– | It establishes a mapping between the artifact/codebase and the application instance. If the entity doesn't exist, it's created | --unit Front |
--external-id |
– | External id of the new application. If the application exists, the parameter will be skipped | --external-id new-app-external-id |
-v |
– | The script version | -v |
* see the "Appendix 3. Scan results section".