Local mode

Run KuboScore directly from your local machine with kuboscore-cli.

The following content assumes you have kubectl binary installed, as well as a privileged access to your cluster.

Get KuboScore

Download KuboScore CLI on a machine that has access to your cluster.

Linux

# Retrieve KuboScore CLI latest version string
export KS_VERSION=$(curl -s https://download.kuboscore.io/binaries/kuboscore-cli-latest.txt)

# Download latest version of KuboScore CLI with curl
curl -O https://download.kuboscore.io/binaries/kuboscore-cli-$KS_VERSION-linux-amd64

# Allow binary execution
chmod +x ./kuboscore-cli-$KS_VERSION-linux-amd64

MacOS

# Retrieve KuboScore CLI latest version string
export KS_VERSION=$(curl -s https://download.kuboscore.io/binaries/kuboscore-cli-latest.txt)

# Download latest version of KuboScore CLI with curl
curl -O https://download.kuboscore.io/binaries/kuboscore-cli-$KS_VERSION-darwin-amd64

# Allow binary execution
chmod +x ./kuboscore-cli-$KS_VERSION-darwin-amd64

Windows (PowerShell)

# Retrieve KuboScore CLI latest version string
Set-Variable -Name "KSVersion" -Value (Invoke-WebRequest -UseBasicParsing -URI https://download.kuboscore.io/binaries/kuboscore-cli-latest.txt).Content

# Download latest version of KuboScore CLI with Invoke-WebRequest
Invoke-WebRequest -URI "https://download.kuboscore.io/binaries/kuboscore-cli-$(Get-Variable -Name "KSVersion" -ValueOnly)-windows.exe" -OutFile ".\kuboscore-cli-$(Get-Variable -Name "KSVersion" -ValueOnly)-windows.exe"

Note: you can check the integrity of your download with the following checksum file.

Usage

Linux

# Execute KuboScore CLI
./kuboscore-cli-$KS_VERSION-linux-amd64 --kubeconfig ~/.kube/config

MacOS

# Execute KuboScore CLI
./kuboscore-cli-$KS_VERSION-darwin-amd64 --kubeconfig ~/.kube/config

Windows (PowerShell)

# Retrieve KuboScore CLI latest version string
Set-Variable -Name "KSVersion" -Value (Invoke-WebRequest -UseBasicParsing -URI https://download.kuboscore.io/binaries/kuboscore-cli-latest.txt).Content

# Execute KuboScore CLI
.\kuboscore-cli-$(Get-Variable -Name "KSVersion" -ValueOnly)-windows.exe `
  --kubeconfig %USERPROFILE%\.kube\config

Option	Description
--kubeconfig, -k	Set kubeconfig file to use Defaults to value of KUBECONFIG environment variable or default config file location (usually $HOME/.kube/config).
--export, -e	Set exported results filename Defaults to kuboscore-results-YYYYMMDD-HHmmss (eg: kuboscore-results-20230126-181857).
--confirm-target, -y	Automatically confirm target cluster
--accept-license	Automatically accept license (make sure to review the license before using this flag).
--cleanup	Clean remaining KuboScore resources (if needed) Keep in mind that resources are automatically removed after the execution. This option is only useful if you killed the process while it was running.

Import results in KuboScore

After the scoring is done, you will get a results file that you can import on the KuboScore website.

Uploading your results file will allow you to get more details and keep track of your previous analysis from one central place.

1. Go to KuboScore

2. Sign in to your account

3. Go to your scorings

4. Use the import feature to upload the results file

5. Review your results!

Import results file.