Commands Reference

This section provides comprehensive documentation for all Kalco commands and their options.

Command Overview

Kalco provides a focused set of commands designed for professional Kubernetes cluster management:

Command Description Usage
kalco context Manage cluster contexts kalco context set/list/use/load
kalco export Export cluster resources kalco export [flags]
kalco version Version information kalco version

Global Flags

All Kalco commands support these global flags:

Flag Description Default
--kubeconfig Path to kubeconfig file ~/.kube/config
--no-color Disable colored output false
--help, -h Show help information -

Context Management

The kalco context command manages cluster configurations and settings.

Subcommands

  • set - Create or update a context
  • list - List all available contexts
  • use - Switch to a specific context
  • show - Display context details
  • current - Show current active context
  • delete - Remove a context
  • load - Import context from existing directory

Usage Examples

# Create a production context
kalco context set my-cluster \
  --kubeconfig ~/.kube/config \
  --output ./my-cluster-export \
  --description "My Cluster Dump" \
  --labels env=test,team=platform

# List all contexts
kalco context list

# Switch to production context
kalco context use production

# Show current context
kalco context current

# Load context from existing export
kalco context load ./existing-kalco-export

Resource Export

The kalco export command exports Kubernetes cluster resources with Git integration.

Flags

Flag Description Default
--git-push Automatically push to remote origin false
--commit-message, -m Custom Git commit message Timestamp-based
--dry-run Show what would be exported false

Usage Examples

# Basic export using active context
kalco export

# Export with Git integration
kalco export --git-push --commit-message "Weekly backup"

# Custom commit message
kalco export --commit-message "Pre-deployment backup"

# Dry run to see what would be exported
kalco export --dry-run

Version Information

The kalco version command displays version and build information.

 kalco version

Output includes:

  • Version number
  • Git commit hash
  • Build timestamp
  • Go version used

Command Aliases

Some commands provide convenient aliases:

Command Aliases
kalco export dump, backup
kalco context list ls
kalco context show info

Error Handling

Kalco provides clear error messages and exit codes:

  • Exit Code 0 - Success
  • Exit Code 1 - General error
  • Exit Code 2 - Configuration error
  • Exit Code 3 - Kubernetes connection error

For more detailed information about specific commands, see the individual command documentation pages.


Table of contents