From 6bff8b15373fd4f2a06bd23492d603b8ee36a835 Mon Sep 17 00:00:00 2001 From: Utkarsh Anand Date: Mon, 5 Oct 2026 14:17:51 +0530 Subject: [PATCH] docs: add format input to README inputs table Signed-off-by: Utkarsh Anand --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 21eff84..dd9d8d1 100644 --- a/README.md +++ b/README.md @@ -184,6 +184,7 @@ jobs: | --- | --- | ---| | files | YAML files or Helm charts to scan for misconfigurations. The files need to be provided with the complete path from the root of the repository. | No (default is `.` which scans the whole repository) | | outputFile | Name of the output file where the scan result will be stored without the extension. | No (default is `results`) | +| format | Output format of the scan results. Can take one or more formats separated by a comma with no spaces. Example - `sarif,json`. When multiple formats are specified, Kubescape produces one file per format using the `outputFile` name, e.g. `results.sarif` and `results.json`. Run `kubescape scan -h` in the [Kubescape CLI](https://hub.armo.cloud/docs/installing-kubescape) to get a list of all supported formats. | No (default is `junit`) | | frameworks | Security framework(s) to scan the files against. Multiple frameworks can be specified separated by a comma with no spaces. Example - `nsa,devopsbest`. Run `kubescape list frameworks` in the [Kubescape CLI](https://hub.armo.cloud/docs/installing-kubescape) to get a list of all frameworks. Either frameworks have to be specified or controls. | No | | controls | Security control(s) to scan the files against. Multiple controls can be specified separated by a comma with no spaces. Example - `Configured liveness probe,Pods in default namespace`. Run `kubescape list controls` in the [Kubescape CLI](https://hub.armo.cloud/docs/installing-kubescape) to get a list of all controls. You can use either the complete control name or the control ID such as `C-0001` to specify the control you want use. You must specify either the control(s) or the framework(s) you want used in the scan. | No | | account | account ID for integrating with a third-party server | No |