CLI Overview
The Ilum CLI (ilum) is a command-line installer and management tool for the Ilum platform. It wraps Helm and kubectl to give you a streamlined workflow for deploying, configuring, and operating Ilum on any Kubernetes cluster.
Key Capabilities
- One-command deployment — get Ilum running on a local or remote cluster with
ilum quickstart - Module management — browse, enable, and disable platform modules with automatic dependency resolution
- Day-2 operations — upgrade, rollback, view logs, check health, inspect configuration, and monitor resources
- Profile-based configuration — manage multiple environments (dev, staging, production) with named profiles
- CI/CD ready — non-interactive mode, machine-readable output (JSON/YAML/CSV), and scripting-friendly exit codes
- Air-gapped support — bundle and transfer images for disconnected environments
Getting Started
If you are new to the Ilum CLI, start here:
- Installation — install the CLI and its prerequisites
- Getting Started — deploy your first cluster
- Working with Modules — customize your Ilum deployment
Going Further
- Day-2 Operations — upgrade, rollback, logs, health checks, and more
- Managing Configuration — profiles, config management, connecting to existing installations
- CI/CD Automation — automate deployments with pipelines
- Uninstalling — clean removal of Ilum and its resources
- Recipes — real-world deployment patterns and workflows
- Command Reference — complete reference for all CLI commands and options