KubeadaptDocsBack to site
Sign inStart free
DocsAPI ReferenceCLI
  • Overview
  • Commands
Docs homev1CliCommands

CLI

CLI Command Reference

Complete command reference for kubeadapt: organization, clusters, namespaces, workloads, pods, nodes, node-groups, recommendations, teams, departments, and authentication.

All commands support the global flags (--output, --api-key, --verbose, etc.). List commands (get clusters, get workloads, etc.) also inherit the pagination flags.

Quick reference

CommandDescription
get overviewOrganization-level summary
get dashboardOrganization dashboard with MTD cost and savings
get clustersList clusters
get cluster <id>Show a single cluster
get namespacesList namespaces
get namespace <name>Show a single namespace
get workloadsList workloads
get workload <uid>Show a single workload
get pods <workload-uid>List pods for a workload
get nodesList nodes
get node <uid>Show a single node
get node-groupsList node groups
get node-group <name>Show a single node group
get recommendationsList recommendations
get recommendation <id>Show a single recommendation
get teamsList teams with cost attribution
get team <id>Show a single team
get team-assignments <id>List assignments for a team
get departmentsList departments with cost attribution
get department <id>Show a single department
healthCheck API server health (unauthenticated)
auth loginStore API key
auth statusShow stored credentials (masked)
auth logoutRemove stored API key
versionBinary version, commit, OS/arch
completionShell completion scripts

Pagination flags

All list commands (get clusters, get workloads, etc.) inherit these flags from the get parent:

FlagTypeDefaultDescription
--cost-modestringfully_loadedCost attribution mode (fully_loaded or workload_only). Applies to namespace, workload, pod, team, and department commands.
--cursorstring—Pagination cursor from a previous response.
--limitint100Page size (1–500).
--paginateboolfalseAutomatically fetch all pages.
--include-totalboolfalseInclude total_count in pagination metadata.

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

ArgumentRequiredDescription
cluster-idyesThe cluster ID to look up

Example

bash
kubeadapt get cluster c1a2b3c4-d5e6-7890-abcd-ef1234567890

get workloads

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

Flags

FlagTypeDefaultDescription
--cluster-idstringFilter by cluster ID
--namespacestringFilter by namespace
--kindstringFilter by kind (e.g. Deployment, StatefulSet)
--limitintMaximum number of results to return
--offsetintNumber of results to skip (for pagination)

Example

bash
kubeadapt get workloads --cluster-id c1a2b3c4-d5e6-7890-abcd-ef1234567890 --namespace default

Sample output:

plaintext
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 workload

kubeadapt get workload <workload-uid>

Shows a single workload by its Kubernetes metadata.uid.

Arguments

ArgumentDescription
workload-uidKubernetes metadata.uid of the workload (required)

Example

bash
kubeadapt get workload b9f1a342-7c5e-4d8a-9e2b-1234567890ab

get pods

kubeadapt get pods <workload-uid>

Lists pods belonging to a workload.

Arguments

ArgumentDescription
workload-uidKubernetes metadata.uid of the parent workload (required)

Flags

FlagTypeDefaultDescription
--namespacestring (repeatable)—Filter by namespace
--node-uidstring (repeatable)—Filter by node UID
--phasestring—Filter by pod phase (Pending, Running, Succeeded, Failed, Unknown)
--qos-classstring—Filter by QoS class (Guaranteed, Burstable, BestEffort)
--has-hostpathboolfalseFilter pods with hostPath volumes
--has-emptydirboolfalseFilter pods with emptyDir volumes
--host-networkboolfalseFilter pods with hostNetwork enabled

Example

bash
kubeadapt get pods b9f1a342-7c5e-4d8a-9e2b-1234567890ab --phase Running

get nodes

Lists nodes in your clusters.

Flags

FlagTypeDefaultDescription
--cluster-idstringFilter by cluster ID
--node-groupstringFilter by node group name
--limitintMaximum number of results to return
--offsetintNumber of results to skip

Example

bash
kubeadapt get nodes --cluster-id c1a2b3c4-d5e6-7890-abcd-ef1234567890

get node

kubeadapt get node <node-uid>

Shows a single node by its Kubernetes metadata.uid.

Arguments

ArgumentDescription
node-uidKubernetes metadata.uid of the node (required)

Example

bash
kubeadapt get node n1a2b3c4-d5e6-7890-abcd-ef0987654321

get node-groups

Lists node groups for your clusters.

Flags

FlagTypeDefaultDescription
--cluster-idstringFilter by cluster ID

Example

bash
kubeadapt get node-groups --cluster-id c1a2b3c4-d5e6-7890-abcd-ef1234567890

get node-group

kubeadapt get node-group <name>

Shows a single node group by name.

Arguments

ArgumentDescription
nameNode group name (required)

Flags

FlagTypeDefaultDescription
--cluster-idstring—Cluster ID that owns the node group (required)

Example

bash
kubeadapt get node-group prod-mixed --cluster-id c1a2b3c4-d5e6-7890-abcd-ef1234567890

get recommendations

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

Flags

FlagTypeDefaultDescription
--cluster-idstringFilter by cluster ID
--typestringRecommendation type (e.g. rightsizing)
--statusstringFilter by status: pending, applied, or dismissed
--limitintMaximum number of results to return
--offsetintNumber of results to skip

Example

bash
kubeadapt get recommendations --type rightsizing --status pending

Sample output:

plaintext
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 recommendation

kubeadapt get recommendation <id>

Shows a single recommendation by ID.

Arguments

ArgumentDescription
idRecommendation UUID (required)

Example

bash
kubeadapt get recommendation f47ac10b-58cc-4372-a567-0e02b2c3d479 -o json

get teams

Lists teams with cost attribution.

Flags

FlagTypeDefaultDescription
--department-idstring (repeatable)—Filter by department ID
--originstring (repeatable)—Filter by origin: k8s (auto-discovered) or kubeadapt (created in dashboard)

Example

bash
kubeadapt get teams -o json

get team

kubeadapt get team <team-id>

Shows a single team by ID.

Arguments

ArgumentDescription
team-idTeam UUID (required)

Example

bash
kubeadapt get team f47ac10b-58cc-4372-a567-0e02b2c3d479

get team-assignments

kubeadapt get team-assignments <team-id>

Lists workload and namespace assignments for a team.

Arguments

ArgumentDescription
team-idTeam UUID (required)

Flags

FlagTypeDefaultDescription
--entity-typestring—Filter by entity type (namespace, workload, cluster)
--cluster-idstring (repeatable)—Filter by cluster ID
--sourcestring—Filter by assignment source: k8s_label, user_manual, namespace_auto

Example

bash
kubeadapt get team-assignments f47ac10b-58cc-4372-a567-0e02b2c3d479 --entity-type workload

get departments

Lists departments with cost attribution.

Flags

FlagTypeDefaultDescription
--originstring (repeatable)—Filter by origin: k8s (auto-discovered) or kubeadapt (created in dashboard)

Example

bash
kubeadapt get departments

get department

kubeadapt get department <dept-id>

Shows a single department by ID.

Arguments

ArgumentDescription
dept-idDepartment UUID (required)

Example

bash
kubeadapt get department a1b2c3d4-e5f6-7890-abcd-ef1234567890

get namespaces

Lists namespaces.

Flags

FlagTypeDefaultDescription
--cluster-idstring—Filter by cluster ID
--teamstring—Filter by team name
--departmentstring—Filter by department name

Example

bash
kubeadapt get namespaces --team platform

get namespace

kubeadapt get namespace <name>

Shows a single namespace by name.

Arguments

ArgumentDescription
nameKubernetes namespace name (required)

Flags

FlagTypeDefaultDescription
--cluster-idstring—Cluster ID that owns the namespace (required)

Example

bash
kubeadapt get namespace payments --cluster-id c1a2b3c4-d5e6-7890-abcd-ef1234567890

health

kubeadapt health

Checks API server health. No authentication required.

Example

bash
kubeadapt health

auth

Manages stored credentials. See Authentication for full details.

SubcommandDescription
auth loginPrompts for API key, saves to config file
auth statusShows the currently stored API key (masked) and API URL
auth logoutRemoves the stored API key from the config file

version

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

bash
kubeadapt version

Example output:

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

completion

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

bash
kubeadapt completion [bash|zsh|fish|powershell]
PreviousCLI ConfigurationCLINextCLI Output FormatsCLI

On this page

  • Quick reference
  • Pagination flags
  • get overview
  • get dashboard
  • Example
  • get clusters
  • Example
  • get cluster
  • Arguments
  • Example
  • get workloads
  • Flags
  • Example
  • get workload
  • Arguments
  • Example
  • get pods
  • Arguments
  • Flags
  • Example
  • get nodes
  • Flags
  • Example
  • get node
  • Arguments
  • Example
  • get node-groups
  • Flags
  • Example
  • get node-group
  • Arguments
  • Flags
  • Example
  • get recommendations
  • Flags
  • Example
  • get recommendation
  • Arguments
  • Example
  • get teams
  • Flags
  • Example
  • get team
  • Arguments
  • Example
  • get team-assignments
  • Arguments
  • Flags
  • Example
  • get departments
  • Flags
  • Example
  • get department
  • Arguments
  • Example
  • get namespaces
  • Flags
  • Example
  • get namespace
  • Arguments
  • Flags
  • Example
  • health
  • Example
  • auth
  • version
  • completion
Edit this page
Kubeadapt

Kubernetes FinOps platform. Cost visibility, rightsizing, and capacity planning that pays for itself in 30 days.

Product

  • Cost Monitoring
  • Cost Attribution
  • Workload Rightsizing
  • Recommendations
  • Smart Alerting
  • Best Practices
  • Network Cross-AZ

Resources

  • Documentation
  • Status Page
  • Feature Requests

Company

  • About Us
  • Security
  • Careers
  • Contact

© 2026 Kubeadapt. All rights reserved.

PrivacyTermsSecurity