Terminal UI for Juju infrastructure orchestration
Project description
⬢ JujuMate
A terminal UI for Juju — monitor all your infrastructure resources in a single interactive screen with real-time updates. Inspired by K9s and KDash.
Features
- 🔄 Auto-refresh — status updates automatically every few seconds; logs stream live via WebSocket
- ☁️ Full resource tree — clouds, controllers, models, applications, units, machines
- 📊 Status view — apps, units, offers, integrations, SAAS and machines in one screen
- 🏥 Health view — shows only unhealthy models by default; toggle to see all with
f - 🔍 Drill-down navigation — select a controller → filter models; select a model → see its full status
- 🔎 Inline filtering — press
/in Status or Logs to search with live highlight - 🔗 Peer relation toggle — press
pto show/hide peer relations in the Integrations panel - 🖥️ Units-per-machine toggle — press
uto show units (and their subordinates) nested under each machine - 🗂️ Collapsible panels — press
xto collapse/expand any Status panel individually; focused panel highlighted in theme colour - 👑 Leader indicators — unit leaders marked with
*(green) followingjuju statusconvention - 🔗 Relation lifecycle — Integrations panel shows live relation status; relations being torn down display as
removing - 📋 Copy to clipboard — press
yin Status or Relation Data to copy the full content - 🔐 Secrets browser — list and inspect Juju secrets per model (
Shift+S) - 📦 Offers browser — browse all cross-model offers in a controller, with endpoint details and live consumer tracking across controllers (
Shift+O) - 📋 Relation databag inspector — examine raw relation data for any relation (
Enteron a relation) - ⚙️ App config viewer — inspect application configuration (
Enteron an app) - 🖥️ Machine detail modal — press
Enteron any machine to see hardware specs, status timestamps and network interfaces - 🎨 Themeable — five built-in themes; fully customisable via YAML
- ⚙️ Settings modal — change theme, refresh interval, default controller and log level at runtime (
Shift+C) - 🪟 Terminal transparency — respects your terminal background (no forced black background)
- ⌨️ K9s-style help overlay — press
?to see all keybindings at any time (full-screen)
Installation
Recommended — install as a tool with uv:
uv tool install jujumate
Or with pipx:
pipx install jujumate
JujuMate reads your existing Juju configuration from ~/.local/share/juju/ automatically — no extra setup needed if juju is already working.
Quick Start
jujumate
On first launch JujuMate connects to your current Juju controller and auto-selects your current model. Use the keyboard shortcuts below to navigate.
Keyboard Shortcuts
Global
| Key | Action |
|---|---|
c |
Go to Clouds tab |
m |
Go to Models tab |
s |
Go to Status tab |
h |
Go to Health tab |
r |
Force refresh |
Esc |
Clear cloud/controller drill-down filter |
? |
Toggle help overlay |
q |
Quit |
Navigation
| Key | Action |
|---|---|
↑ / ↓ |
Move cursor up/down |
Enter |
Drill-down / open detail |
Status tab
| Key | Action |
|---|---|
/ |
Filter by app name, charm, channel or message (with live highlight) |
Esc |
Clear filter |
p |
Toggle peer relations in the Integrations panel |
u |
Toggle units (and subordinates) nested under each machine |
x |
Collapse/expand the current panel |
y |
Copy full status to clipboard (includes cloud, controller, model and Juju version) |
Enter on app |
Open App Config viewer |
Enter on offer |
Open Offer detail |
Enter on relation |
Open Relation Data inspector |
Enter on machine |
Open Machine detail modal (hardware, status, network) |
Health tab
| Key | Action |
|---|---|
f |
Toggle between unhealthy-only (default) and all models |
Modals
| Key | Action |
|---|---|
Shift+S |
Open Secrets browser for the current model |
Shift+O |
Open Offers browser for the current controller |
Shift+L |
Open live Log viewer for the current model |
Shift+C |
Open Settings modal (appearance, behaviour, diagnostics) |
Enter |
Open detail view |
y |
Copy value to clipboard (Relation Data / Secrets) |
Esc |
Close modal |
Views
Status
The main view. Displays a full juju status-style breakdown of the selected model:
- Applications — name, charm, channel, revision, units, status and workload message
- Units — workload/agent status, machine or pod, address, ports; subordinates shown nested under their principal; leader units are marked with
* - Machines — id, state, address, instance, base, AZ (IaaS models only); press
uto expand units and their subordinates inline; pressEnteron a machine to open its detail modal
Press Enter on a machine to see:
- Hardware — architecture, CPU cores, memory, root disk size, virtualisation type
- Status — agent and instance status with relative timestamps (e.g. 2h ago)
- Network interfaces — name, IP address, MAC address and Juju space for each NIC
- SAAS — consumed remote offers and their status
- Offers — cross-model offers with active/total connection counts
- Integrations — regular and cross-model relations with live status column (peer relations hidden by default; press
pto toggle); relations being removed show asremoving
Each panel can be collapsed individually with x while it has focus, and expanded again with x. The focused panel is highlighted with a distinct border colour (violet in Monokai and Ubuntu themes).
Health
Shows a summary of all models across all controllers, highlighting those with errors or blocked units. Unhealthy models are shown by default; press f to toggle between unhealthy-only and all models.
Offers browser (Shift+O)
Lists all offers across every model in the current controller. Select an offer to see:
- Model, URL, application, charm, description and access level
- Endpoint details (name, interface, role)
- Live consumer list — scans all known controllers to find which models and applications are consuming the offer
Secrets browser (Shift+S)
Lists all secrets visible in the current model. Select a secret to see its metadata (owner, revision, rotation policy, timestamps).
Log viewer (Shift+L)
Streams live log entries from the current model. Use / to filter by text.
Relation Data inspector
Press Enter on any relation in the Status tab to open a databag viewer showing the application-level and unit-level relation data for both sides of the relation. Press y to copy the full content to clipboard.
App Config viewer
Press Enter on any application in the Status tab to inspect its current configuration values.
Machine detail modal
Press Enter on any machine row in the Machines panel to open a modal showing:
- Instance ID, address, base OS, availability zone, controller and model
- Hardware — architecture, CPU cores, memory, root disk size and virtualisation type (parsed from Juju's hardware string)
- Status — agent and instance status with relative timestamps (e.g. started 2h ago)
- Network interfaces — name, IP address, MAC address and Juju space for each NIC
Section titles adapt to the active theme's accent colour. Press Esc to close.
Configuration
JujuMate is configured via ~/.config/jujumate/config.yaml. All fields are optional.
# ~/.config/jujumate/config.yaml
theme: ubuntu # Theme name (default: ubuntu)
refresh_interval: 5 # Seconds between auto-refresh (default: 5)
default_controller: prod # Controller to use (default: current Juju controller)
log_file: ~/.local/state/jujumate/jujumate.log
log_level: INFO # DEBUG | INFO | WARNING | ERROR | CRITICAL
Most settings can also be changed at runtime — press Shift+C to open the Settings modal, which lets you change the theme (with live preview), refresh interval, default controller and log level without editing the file manually. Changes are saved immediately.
Themes
JujuMate ships with five built-in themes: ubuntu (default), dark, monokai, solarized-dark and spacemacs.
Press Shift+C to open the Settings modal, then select a theme in the Appearance section to preview it live before it's applied.
To create a custom theme, add a YAML file to ~/.config/jujumate/themes/:
# ~/.config/jujumate/themes/mytheme.yaml
name: mytheme
primary: "#FF6600"
secondary: "#003366"
background: "#1a1a2e"
surface: "#16213e"
dark: true
Then set it in your config:
theme: mytheme
Available fields: primary, secondary, accent, background, surface, panel, warning, error, success, foreground, dark.
User themes override built-in themes with the same name.
Development
Requirements: Python 3.10+, uv
git clone https://github.com/Abuelodelanada/jujumate.git
cd jujumate
uv sync
Run from source:
uv run jujumate
Run checks (lint + typecheck + tests):
uv run nox
Individual sessions:
uv run nox -s tests # Run tests with coverage
uv run nox -s lint # Ruff lint + format check
uv run nox -s typecheck # Pyright static analysis
uv run ruff format src tests # Auto-format code
License
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file jujumate-0.2.8.tar.gz.
File metadata
- Download URL: jujumate-0.2.8.tar.gz
- Upload date:
- Size: 255.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a276e9dc6749251d6f1adffb00cd1e59b9f6788175c66ecf899b01e2106f0ca7
|
|
| MD5 |
8af152624744b86483881d92d22c4b03
|
|
| BLAKE2b-256 |
bf4dc302a4220bb54eaf86fafacc500ce3bce518a9fbae8584589d886879086e
|
Provenance
The following attestation bundles were made for jujumate-0.2.8.tar.gz:
Publisher:
tag-and-release.yaml on Abuelodelanada/jujumate
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
jujumate-0.2.8.tar.gz -
Subject digest:
a276e9dc6749251d6f1adffb00cd1e59b9f6788175c66ecf899b01e2106f0ca7 - Sigstore transparency entry: 1197137623
- Sigstore integration time:
-
Permalink:
Abuelodelanada/jujumate@9a21aa463b7d1f1789f30dce3acf800a3817fbce -
Branch / Tag:
refs/heads/main - Owner: https://github.com/Abuelodelanada
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
tag-and-release.yaml@9a21aa463b7d1f1789f30dce3acf800a3817fbce -
Trigger Event:
push
-
Statement type:
File details
Details for the file jujumate-0.2.8-py3-none-any.whl.
File metadata
- Download URL: jujumate-0.2.8-py3-none-any.whl
- Upload date:
- Size: 95.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7b54135fd0511f2a2a948dd44f109feae9ae40ad0e15c7e26b30d9124a6ceb0a
|
|
| MD5 |
99b2421b3de81c7753ad5494e1def281
|
|
| BLAKE2b-256 |
4ae4e793c0e68abf4513c2e70404082a9fe98c1a9dfac5153f998047bccddbbb
|
Provenance
The following attestation bundles were made for jujumate-0.2.8-py3-none-any.whl:
Publisher:
tag-and-release.yaml on Abuelodelanada/jujumate
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
jujumate-0.2.8-py3-none-any.whl -
Subject digest:
7b54135fd0511f2a2a948dd44f109feae9ae40ad0e15c7e26b30d9124a6ceb0a - Sigstore transparency entry: 1197137649
- Sigstore integration time:
-
Permalink:
Abuelodelanada/jujumate@9a21aa463b7d1f1789f30dce3acf800a3817fbce -
Branch / Tag:
refs/heads/main - Owner: https://github.com/Abuelodelanada
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
tag-and-release.yaml@9a21aa463b7d1f1789f30dce3acf800a3817fbce -
Trigger Event:
push
-
Statement type: