CLI Command Reference

All commands query Kubernetes cluster data via the Kubeadapt API and support the global flags (--output, --api-key, --verbose, etc.).

Quick reference

Command	Description
`get overview`	Organization-level summary (clusters, workloads, costs)
`get dashboard`	Organization dashboard summary
`get clusters`	List all clusters
`get cluster [id]`	Single cluster details
`get workloads`	Workloads with cost and efficiency data
`get nodes`	Node list with resource info
`get node-groups`	Node groups per cluster
`get recommendations`	Rightsizing and optimization suggestions
`get costs teams`	Cost breakdown by team label
`get costs departments`	Cost breakdown by department label
`get namespaces`	Namespaces with team/department filters
`get persistent-volumes`	PVs by cluster, namespace, or storage class
`auth login`	Store API key
`auth status`	Show stored credentials (masked)
`auth logout`	Remove stored API key
`version`	Binary version, commit, OS/arch
`completion`	Shell completion scripts

get overview

Shows an organization-level summary including total clusters, workloads, and cost figures.

bash

kubeadapt get overview

No additional flags.

get dashboard

Shows an organization dashboard with hero metrics, MTD spending, and top clusters.

Example

bash

kubeadapt get dashboard

get clusters

Lists all clusters in your organization.

bash

kubeadapt get clusters

No additional flags.

Example

bash

kubeadapt get clusters -o json

get cluster

Shows details for a single cluster. Requires the cluster ID as a positional argument.

Arguments

Argument	Required	Description
`cluster-id`	yes	The cluster ID to look up

Example

bash

kubeadapt get cluster cls-abc123

get workloads

Lists workloads across your clusters. You can filter by cluster, namespace, or workload kind.

Flags

Flag	Type	Description
`--cluster-id`	string	Filter by cluster ID
`--namespace`	string	Filter by namespace
`--kind`	string	Filter by kind (e.g. `Deployment`, `StatefulSet`)
`--limit`	int	Maximum number of results to return
`--offset`	int	Number of results to skip (for pagination)

Example

bash

kubeadapt get workloads --cluster-id cls-abc123 --namespace default

Sample output:

text

NAME              KIND          NAMESPACE    CLUSTER       REPLICAS   EFFICIENCY   MONTHLY $   $/HR
api-gateway       Deployment    payments     production    3/3        34.2%        $128.40     $0.18
redis-primary     StatefulSet   cache        production    1/1        72.8%        $45.60      $0.06
worker            Deployment    jobs         production    5/5        18.1%        $312.00     $0.43

See API: Workloads for the full response schema.

get nodes

Lists nodes in your clusters.

Flags

Flag	Type	Description
`--cluster-id`	string	Filter by cluster ID
`--node-group`	string	Filter by node group name
`--limit`	int	Maximum number of results to return
`--offset`	int	Number of results to skip

Example

bash

kubeadapt get nodes --cluster-id cls-abc123

get node-groups

Lists node groups for your clusters.

Flags

Flag	Type	Default	Description
`--cluster-id`	string		Filter by cluster ID

Example

bash

kubeadapt get node-groups --cluster-id cls-abc123

get recommendations

Lists optimization recommendations. Filter by type and status to narrow results.

Flags

Flag	Type	Description
`--cluster-id`	string	Filter by cluster ID
`--type`	string	Recommendation type (e.g. `rightsizing`)
`--status`	string	Filter by status: `pending`, `applied`, or `dismissed`
`--limit`	int	Maximum number of results to return
`--offset`	int	Number of results to skip

Example

bash

kubeadapt get recommendations --type rightsizing --status pending

Sample output:

text

ID          TYPE          CLUSTER       RESOURCE                    PRIORITY   STATUS    MONTHLY SAVINGS
rec-a1b2    rightsizing   production    payments/api-gateway        high       pending   $42.80
rec-c3d4    rightsizing   production    monitoring/prometheus        medium     pending   $18.50
rec-e5f6    rightsizing   production    default/nginx-ingress       low        pending   $6.20

See Right-sizing for how recommendations are generated.

get costs teams

Shows cost breakdown by team.

Flags

Flag	Type	Default	Description
`--cluster-id`	string		Filter by cluster ID

Example

bash

kubeadapt get costs teams -o json

Sample table output:

text

TEAM         NAMESPACES   WORKLOADS   PODS   CPU      MEMORY     $/HR     $/MO
platform     4            12          28     14.2     52.8 GB    $2.84    $2,044.80
backend      3            8           15     8.6      32.0 GB    $1.72    $1,238.40
data         2            5           10     24.0     96.0 GB    $4.80    $3,456.00

See Cost Attribution for how costs are calculated per team.

get costs departments

Shows cost breakdown by department.

Flags

Flag	Type	Default	Description
`--cluster-id`	string		Filter by cluster ID

Example

bash

kubeadapt get costs departments

get namespaces

Lists namespaces. You can filter by team or department label.

Flags

Flag	Type	Description
`--cluster-id`	string	Filter by cluster ID
`--team`	string	Filter by team name
`--department`	string	Filter by department name

Example

bash

kubeadapt get namespaces --team platform

get persistent-volumes

Lists persistent volumes. The alias pvs is also accepted.

Flags

Flag	Type	Description
`--cluster-id`	string	Filter by cluster ID
`--namespace`	string	Filter by namespace
`--storage-class`	string	Filter by storage class name

Example

bash

kubeadapt get pvs --storage-class gp3

See Storage Analysis for PV cost details in the dashboard.

auth

Manages stored credentials. See Authentication for full details.

Subcommand	Description
`auth login`	Prompts for API key, saves to config file
`auth status`	Shows the currently stored API key (masked) and API URL
`auth logout`	Removes the stored API key from the config file

version

Prints the binary version, commit hash, build date, Go version, and OS/architecture.

bash

kubeadapt version

Example output:

text

kubeadapt v0.5.0
  Commit:     a1b2c3d
  Built:      2026-03-11T10:00:00Z
  Go version: go1.26.0
  OS/Arch:    darwin/arm64

completion

Generates shell completion scripts. See Shell completions for setup instructions per shell.

bash

kubeadapt completion [bash|zsh|fish|powershell]