Skip to content

CLI Reference

The cakd command-line interface (CLI) is the central tool for managing the Cloud-Agnostic Kubernetes Developer (CAKD) Platform. Use it to initialize platform infrastructure, create new projects, validate configurations, and run AI-powered diagnostic observation on your workloads.

CAKD Platform CLI — Cloud-Agnostic Kubernetes Developer Platform.

Terminal window
cakd [command]
  • init — Bootstrap the Kubernetes cluster with platform infrastructure.
  • create — Generate a new cloud-native project.
  • validate — Verify a platform.yaml configuration file.
  • observe — Diagnose and troubleshoot projects using AI.
  • version — View current CLI version details.

Bootstrap your Kubernetes cluster with core platform infrastructure including ArgoCD, Prometheus, and Loki.

Terminal window
cakd init [flags]

Note: If no flags are specified, cakd init defaults to installing all components (--argocd, --monitoring, and --logging).

FlagShorthandTypeDefaultDescription
--argocd-booleanfalseInstall ArgoCD.
--monitoring-booleanfalseInstall Prometheus & Grafana.
--logging-booleanfalseInstall Loki.

Initialize all cluster infrastructure components:

Terminal window
cakd init

Install only ArgoCD and Logging components:

Terminal window
cakd init --argocd --logging

Create a new cloud-native project defined in a configuration file.

Terminal window
cakd create [flags]
FlagShorthandTypeDefaultDescription
--file-fstring"platform.yaml"Path to the platform.yaml configuration file.
--force-booleanfalseForce overwrite the existing project directory if it already exists.

Generate a project using the default config file location:

Terminal window
cakd create

Force-overwrite an existing project using a custom configuration file:

Terminal window
cakd create --file ./deployments/custom-platform.yaml --force

Validate the syntax and structure of a platform.yaml configuration file without deploying any resources.

Terminal window
cakd validate [flags]
FlagShorthandTypeDefaultDescription
--file-fstring"platform.yaml"Path to the platform.yaml file to validate.

Validate the platform.yaml in the current working directory:

Terminal window
cakd validate

Validate a specific configuration file:

Terminal window
cakd validate -f ./configs/my-app.yaml

Diagnose, troubleshoot, and observe a running project using AI integration. This command gathers telemetry metrics and log data to output a holistic diagnosis of your project.

Terminal window
cakd observe <project-name> [flags]
ArgumentTypeDescription
<project-name>string (Required)The exact name of the project/workload to diagnose.

This command requires connection to the Google Gemini API. You must configure the following variable in your environment:

Variable NameDescription
GEMINI_API_KEYYour Gemini AI API credential.

Export your API Key and run diagnosis on a project named payment-gateway:

Terminal window
export GEMINI_API_KEY="your-gemini-api-key-here"
cakd observe payment-gateway

Print the version information of the CAKD Platform CLI.

Terminal window
cakd version