unCtl cli

Once installed, you can quickly verify the installation by running the following command:

unctl -v

This will output the version of unCtl that you have installed, like so:

0.9.3

To view the list of commands and usage options available with unCtl, run the following command in your terminal:

unctl -h

This command will display the help information, detailing the various options, subcommands, and usage patterns for unCtl. If unCtl supports specific providers, their corresponding commands will be listed under their respective sections within the help output.

Scan

To explore options for interacting with provider using unCtl, use this command in your terminal:

unctl k8s -h

To initiate a simple scan with unCtl for a specific provider, you will need to utilize the -s option in your command. Here is how you can perform this action in the terminal:

unctl <provider> -s

Replace <provider> with the actual provider name that you intend to scan. After executing the command, unCtl will start a scan and provide output summarising the findings.

unctl k8s -s

After replacing <provider> with k8s, the command will begin a scan on your Kubernetes setup. You should see output that details the scan progress and summaries the results once the scan is complete.

Filters

To perform more specific scans using unCtl, you can apply filters such as check ID, service, or category. Also it is possible to ignore particular checks or object.

K8S Examples:

• Run scan for particular namespace and show only failures

unctl k8s -s --namespaces dev --failing-only

• Run scan for particular check (list of checks):

unctl k8s -s --checks K8S101

• Run scan for particular category and/or service:

unctl k8s -s --categories HPA --services pod

Along with cli options it is possible to set same values via config file.

Look at more examples here.