Getting Started

What Is flux9s?

flux9s is a terminal UI for watching Flux resources and the cluster state around them in real time. It is designed for operators who already live in a shell and want fast visibility into what Flux is doing, how resources relate to each other, and whether quick intervention is needed.

That includes core Flux resources such as Kustomization, HelmRelease, and source objects, plus Flux Operator resources such as FluxInstance and ResourceSet. From the same interface you can inspect YAML, trace ownership, open graph and history views, and run common actions like suspend, resume, and reconcile.

Why Use It If Flux Operator Has a Web UI?

The Flux Operator Web UI is excellent for browser-based visibility. flux9s complements it with a terminal-first workflow: keyboard navigation, quick context switching, namespace-scoped live watches, and operational actions without leaving your current shell session.

Quick Start

Follow these steps to get started with flux9s:

1. Install flux9s

Choose your preferred installation method from the Installation Guide:

• Homebrew (macOS/Linux): brew install dgunzy/tap/flux9s
• cargo-binstall: cargo binstall flux9s
• From source: cargo install flux9s

2. Prerequisites

• A Kubernetes cluster with Flux CD installed
• kubeconfig configured to access your cluster

3. Run flux9s

flux9s

Or use a specific kubeconfig file:

flux9s --kubeconfig /path/to/kubeconfig

By default, flux9s watches the flux-system namespace. Use :ns all to view all namespaces or :ns <namespace> to switch to a specific namespace.

Next Steps

• Installation Guide - Detailed installation instructions for all platforms and methods
• User Guide - Learn how to navigate and use flux9s effectively
• Configuration - Customize flux9s to suit your workflow and preferences