Commands Overview¶

kindplane provides a comprehensive set of commands for managing your local Crossplane development environment.

Command Structure¶

kindplane [command] [subcommand] [flags]

Global Flags¶

These flags are available for all commands:

Flag	Short	Description
`--config`	`-c`	Configuration file (default: `./kindplane.yaml`)
`--verbose`	`-V`	Enable verbose output
`--help`	`-h`	Show help for the command

Core Commands¶

Command	Description
init	Initialise a new configuration file
validate	Validate configuration file
up	Create and bootstrap a cluster
down	Delete the cluster
status	Show cluster status
dump	Export cluster resources
doctor	Check system requirements and prerequisites
logs	Stream logs from cluster components
diagnostics	Run diagnostics on cluster components
apply	Apply Crossplane resources to the cluster

Management Commands¶

Command	Description
provider	Manage Crossplane providers
chart	Manage Helm charts
credentials	Configure cloud credentials
cluster	Manage Kind clusters
config	View and compare configuration

Quick Reference¶

Create a Development Environment¶

# Check system requirements
kindplane doctor

# Initialise configuration
kindplane init

# Bootstrap cluster
kindplane up

# Check status
kindplane status

Manage the Cluster¶

# Add a provider
kindplane provider add provider-gcp xpkg.upbound.io/upbound/provider-gcp:v1.0.0

# Install a chart
kindplane chart install prometheus https://prometheus-community.github.io/helm-charts kube-prometheus-stack

# Apply compositions
kindplane apply --from-config

# View logs
kindplane logs --component crossplane

# Export resources
kindplane dump -o ./exported

Troubleshoot Issues¶

# Run diagnostics
kindplane diagnostics

# Stream logs from providers
kindplane logs --component providers --follow

# View configuration
kindplane config show

Clean Up¶

# Delete the cluster
kindplane down --force

Getting Help¶

Get help for any command:

kindplane --help
kindplane up --help
kindplane provider --help
kindplane config show --help