Native CLI Usage¶

Use the native kubebuddy binary when you want the primary local runtime for KubeBuddy.

This page covers command usage. It does not repeat install steps from Install or first-run guidance from Getting Started.

Core Commands¶

Guided Buddy Flow¶

kubebuddy guided

Alias:

kubebuddy buddy

Use this when you want the interactive Buddy-style workflow instead of typing the full command yourself.

Full Report Workflow¶

kubebuddy run --html-report --yes --output-path ./reports

Add other formats as needed:

kubebuddy run --json-report --csv-report --txt-report --yes --output-path ./reports

Direct Scan Output¶

kubebuddy scan --output text

Structured output:

kubebuddy scan --output json
kubebuddy scan --output csv
kubebuddy scan --output html

AKS Checks¶

Live AKS:

kubebuddy scan-aks \
  --subscription-id <subscription-id> \
  --resource-group <resource-group> \
  --cluster-name <cluster-name> \
  --output json

From an AKS JSON document:

kubebuddy scan-aks --input ./aks-cluster.json --output json

Cluster Access Checks¶

kubebuddy probe
kubebuddy summary

Check Catalog¶

kubebuddy checks
kubebuddy checks --checks-dir checks/aks

Container-Style Entry Point¶

kubebuddy run-env

This uses the same env-driven runtime shape as the container image.

Common Native Workflows¶

Run AKS and Kubernetes Together¶

kubebuddy run \
  --aks \
  --subscription-id <subscription-id> \
  --resource-group <resource-group> \
  --cluster-name <cluster-name> \
  --html-report \
  --json-report \
  --yes \
  --output-path ./reports

Add Prometheus¶

Azure auth mode using the active Azure identity in your environment. On developer machines this is often az login; in automation it is usually service principal credentials.

kubebuddy run \
  --html-report \
  --include-prometheus \
  --prometheus-url "https://<workspace>.prometheus.monitor.azure.com" \
  --prometheus-mode azure \
  --yes \
  --output-path ./reports

Bearer token mode:

export MY_PROM_TOKEN="<token>"

kubebuddy run \
  --html-report \
  --include-prometheus \
  --prometheus-url "https://prom.example.com" \
  --prometheus-mode bearer \
  --prometheus-bearer-token-env MY_PROM_TOKEN \
  --yes \
  --output-path ./reports