Skip to main content

ilum CLI

Deploy and manage the Ilum Data Lakehouse platform on Kubernetes — from a single command.

Python 3.11+

What is ilum?

The ilum CLI wraps Helm and kubectl into a single tool purpose-built for the Ilum platform. It manages 32 modules with automatic dependency resolution, detects configuration drift between upgrades, and provides interactive wizards, health checks, and structured output — so you never have to hand-edit Helm values or chase dependency order again.

Quickstart

Install

Linux / macOS

curl -fsSL https://get.ilum.cloud/cli | bash

Windows (PowerShell)

irm https://get.ilum.cloud/cli/windows | iex

pip / pipx / uv

pip install ilum        # or: pipx install ilum / uv tool install ilum

Deploy

ilum quickstart

One command that:

  • Checks prerequisites (Helm, kubectl, Docker)
  • Detects an existing cluster or creates a local one (k3d/minikube/kind)
  • Installs the Ilum platform with sensible defaults
  • Shows deployment status when complete

Once running:

ilum status        # release info, pod readiness, enabled modules
ilum access open   # open the Ilum UI in your browser

Step-by-step alternative

Prefer full control? Use the interactive wizard instead:

ilum init       # configure cluster, select modules, set options
ilum install    # deploy with your configuration

Key Commands

Command Description
Setup ilum init Interactive setup wizard
ilum quickstart One-command install with defaults
ilum install Install the platform
ilum upgrade Upgrade an existing installation
ilum connect Attach to an existing Ilum release
Operations ilum status Release info, pod readiness, modules
ilum doctor Run 13 health checks
ilum logs <module> Stream pod logs
ilum exec <module> Shell into a pod
ilum top Resource usage per module
Modules ilum module enable <name> Enable a module (resolves deps)
ilum module disable <name> Disable a module
ilum module list List all 32 available modules
Config ilum values View live Helm values
ilum diff Compare values across sources
ilum rollback Roll back to a previous revision
ilum config Manage CLI configuration and profiles
ilum cleanup Tiered full-environment teardown

Modules

Ilum ships with 32 optional modules organized into 10 categories. When you enable a module, the CLI automatically resolves and enables its dependencies.

Category Modules
Core core, ui, api, livy-proxy
Notebooks jupyter, jupyterhub, zeppelin
SQL & Catalogs sql (Kyuubi), trino, hive-metastore, nessie, unity-catalog
Orchestration airflow, kestra, n8n, nifi, mageai
Analytics superset, streamlit, marquez
AI & ML mlflow, langfuse
Infrastructure mongodb, kafka, postgresql, gitea, clickhouse
Storage minio
Monitoring monitoring (Prometheus + Grafana), loki, graphite
Security openldap
# Enable langfuse — automatically pulls in postgresql + clickhouse
ilum module enable langfuse

Prerequisites

Tool Minimum Version Notes
Helm 3.12+ Required
kubectl 1.28+ Required
Docker 24.0+ For local clusters only

ilum quickstart and ilum deps install handle missing tools automatically.

Documentation

Full documentation is available at ilum.cloud/docs.

Metadata

Release files for ilum 6.7.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ilum 6.7.3
File Size Uploaded Provenance Actions
ilum-6.7.3.tar.gz 374.3 kB Without provenance Details for ilum-6.7.3.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for ilum 6.7.3
File Interpreter ABI Platform Actions
ilum-6.7.3-py3-none-any.whl Python 3 none any Details for ilum-6.7.3-py3-none-any.whl

Total release size: 557.4 kB

Release files / ilum-6.7.3.tar.gz

Download URL ilum-6.7.3.tar.gz
Size 374.3 kB
Tags Source
SHA-256 checksum
How to use checksums
75a1e9b9dea98cf912c6e954616b009bfac26baf1429d8e074576a83a52ac5ea
BLAKE2b-256 checksum
How to use checksums
500fab4f7930d568eabae2d9c4831e41028b412375afc5293b9bbcb1e65db63a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.11.28 {"installer":{"name":"uv","version":"0.11.28","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / ilum-6.7.3-py3-none-any.whl

Download URL ilum-6.7.3-py3-none-any.whl
Size 183.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ab6e16d0abefae9bac2d2e6648fde9ffd46c6b549dcea55ce92fceef3c906b5e
BLAKE2b-256 checksum
How to use checksums
f9c88eedf01d57f229c342f548689cac8d9c8e2fe1138023a69b84b19a847c4e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.11.28 {"installer":{"name":"uv","version":"0.11.28","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Security for ilum 6.7.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

6.7.3 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page