GlassFlow CLI

Local development environment for GlassFlow ETL

The GlassFlow CLI provides a quick way to set up a local development environment for exploring and testing GlassFlow - an open-source ETL tool for real-time data processing from Kafka to ClickHouse.

Note: This CLI is designed for local testing, demos, and exploration only. For production deployments, use the official GlassFlow Helm charts.

⚡️ Quick Start

Prerequisites

• Docker (or compatible runtime like Docker Desktop, OrbStack, Colima, or Podman)
• kubectl (installed automatically via Homebrew, or install manually)

Installation

Install via Homebrew (Recommended)

brew tap glassflow/tap
brew install glassflow

Install from GitHub Releases

Download the latest release for your platform from GitHub Releases.

Usage

Start the local development environment with demo data:

glassflow up --demo

This command will:

• Create a local Kubernetes cluster using Kind
• Install Kafka, ClickHouse, and GlassFlow using Helm charts
• Set up a demo pipeline with sample data
• Configure port forwarding for UI and API access

Once started, you can access:

• GlassFlow UI: http://localhost:30080
• GlassFlow API: http://localhost:30180
• ClickHouse HTTP: http://localhost:30090

Stop the environment:

glassflow down

What Gets Installed

When running glassflow up --demo, the CLI installs:

• Kind: Local Kubernetes cluster
• Kafka: Message broker (Bitnami Helm chart)
• ClickHouse: Columnar database (Bitnami Helm chart)
• GlassFlow ETL: Real-time streaming ETL service (GlassFlow Helm chart)
• Demo Pipeline: Pre-configured pipeline with sample data

Commands

# Start local environment with demo
glassflow up --demo

# Stop and clean up environment
glassflow down

# Show version
glassflow version

# Get help
glassflow --help

Production Deployment

For production use, deploy GlassFlow using the official Helm charts:

• Helm Charts Repository: github.com/glassflow/charts
• Installation Guide: docs.glassflow.dev/installation/kubernetes

Resources

• GlassFlow ETL: github.com/glassflow/clickhouse-etl
• Documentation: docs.glassflow.dev
• Slack Community: Join GlassFlow Hub
• Helm Charts: github.com/glassflow/charts