Skip to content

Getting Started

This is the shortest path from install to a real report.

1. Verify Access

kubebuddy probe

If that succeeds, KubeBuddy can reach your current Kubernetes context.

2. Optional: Inspect the Cluster Quickly

kubebuddy summary

This gives you a fast count of common resources before a full run.

3. Generate Your First Report

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

That writes reports into ./reports.

3a. Use The Guided Buddy Flow

If you want the old menu-style experience, use the guided command:

kubebuddy guided

This walks you through report type, AKS options, Prometheus, exclusions, and output path using the Buddy prompt flow.

4. Use Direct Terminal Output Instead

kubebuddy scan --output text

Use scan when you want output in the terminal. Use run when you want report files.

5. Add AKS Checks

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

6. Add Prometheus

If you are using Azure Managed Prometheus, make sure Azure auth is already available in your environment. Local shells commonly use az login; CI and containers commonly use service principal variables.

kubebuddy run \
  --html-report \
  --include-prometheus \
  --prometheus-url <prometheus-url> \
  --prometheus-mode azure \
  --yes \
  --output-path ./reports

For bearer-token mode:

export MY_PROM_TOKEN="<token>"

kubebuddy run \
  --html-report \
  --include-prometheus \
  --prometheus-url <prometheus-url> \
  --prometheus-mode bearer \
  --prometheus-bearer-token-env MY_PROM_TOKEN \
  --yes \
  --output-path ./reports

Where To Go Next