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.
Global Command
Section titled “Global Command”CAKD Platform CLI — Cloud-Agnostic Kubernetes Developer Platform.
cakd [command]Available Commands
Section titled “Available Commands”init— Bootstrap the Kubernetes cluster with platform infrastructure.create— Generate a new cloud-native project.validate— Verify aplatform.yamlconfiguration file.observe— Diagnose and troubleshoot projects using AI.version— View current CLI version details.
cakd init
Section titled “cakd init”Bootstrap your Kubernetes cluster with core platform infrastructure including ArgoCD, Prometheus, and Loki.
cakd init [flags]Note: If no flags are specified,
cakd initdefaults to installing all components (--argocd,--monitoring, and--logging).
| Flag | Shorthand | Type | Default | Description |
|---|---|---|---|---|
--argocd | - | boolean | false | Install ArgoCD. |
--monitoring | - | boolean | false | Install Prometheus & Grafana. |
--logging | - | boolean | false | Install Loki. |
Examples
Section titled “Examples”Initialize all cluster infrastructure components:
cakd initInstall only ArgoCD and Logging components:
cakd init --argocd --loggingcakd create
Section titled “cakd create”Create a new cloud-native project defined in a configuration file.
cakd create [flags]| Flag | Shorthand | Type | Default | Description |
|---|---|---|---|---|
--file | -f | string | "platform.yaml" | Path to the platform.yaml configuration file. |
--force | - | boolean | false | Force overwrite the existing project directory if it already exists. |
Examples
Section titled “Examples”Generate a project using the default config file location:
cakd createForce-overwrite an existing project using a custom configuration file:
cakd create --file ./deployments/custom-platform.yaml --forcecakd validate
Section titled “cakd validate”Validate the syntax and structure of a platform.yaml configuration file without deploying any resources.
cakd validate [flags]| Flag | Shorthand | Type | Default | Description |
|---|---|---|---|---|
--file | -f | string | "platform.yaml" | Path to the platform.yaml file to validate. |
Examples
Section titled “Examples”Validate the platform.yaml in the current working directory:
cakd validateValidate a specific configuration file:
cakd validate -f ./configs/my-app.yamlcakd observe
Section titled “cakd observe”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.
cakd observe <project-name> [flags]Arguments
Section titled “Arguments”| Argument | Type | Description |
|---|---|---|
<project-name> | string (Required) | The exact name of the project/workload to diagnose. |
Environment Variables
Section titled “Environment Variables”This command requires connection to the Google Gemini API. You must configure the following variable in your environment:
| Variable Name | Description |
|---|---|
GEMINI_API_KEY | Your Gemini AI API credential. |
Examples
Section titled “Examples”Export your API Key and run diagnosis on a project named payment-gateway:
export GEMINI_API_KEY="your-gemini-api-key-here"cakd observe payment-gatewaycakd version
Section titled “cakd version”Print the version information of the CAKD Platform CLI.
cakd version