Krateoctl
krateoctl is the CLI for Krateo install, upgrade, migration, and version-aware composition operations.
Installation​
Automatic installation (Linux/macOS)​
Using curl​
You can install the latest version of krateoctl easily by running the following command in your terminal:
curl -sL https://raw.githubusercontent.com/krateoplatformops/krateoctl/main/install.sh | bash
This script will:
- Detect your operating system and architecture
- Download the latest release binary
- Install it into /usr/local/bin (requires sudo)
- otherwise fallback to $HOME/.local/bin
- Make sure the install directory is in your PATH environment variable
Using Homebrew (macOS)​
brew tap krateoplatformops/krateoctl
brew install krateoctl
Manual installation (Windows or other OS)​
For Windows or if you prefer manual installation:
- Go to the Releases page
- Download the appropriate archive for your OS and architecture
- Extract the binary
- Add the extracted binary to your system's PATH
Getting Help​
Every krateoctl command includes detailed help documentation accessible via the -h flag:
# Show top-level help and available commands
krateoctl -h
# Show help for a specific subcommand
krateoctl install -h
# Show help for a specific command action
krateoctl install plan -h
krateoctl install apply -h
The help output includes flags, examples, and usage information for each command. This is the most up-to-date reference for command options.
Technical Reference​
Environment Variables​
| Name | Description | Default |
|---|---|---|
KUBECONFIG | Path to the Kubernetes configuration file | ~/.kube/config |
KRATEOCONFIG | Path to the krateoctl configuration file | ~/.krateoctl.yaml |
Command Reference​
GitOps Examples​
To accelerate the adoption and integration of Krateo into your GitOps workflows, we provide a collection of ready-to-use examples. These demonstrate how to define and manage compositions, resources, and portal configurations through Git repositories.
You can explore these practical examples in our dedicated repository: krateoplatformops/releases/gitops-examples