configui 1.0.0

A tool that turns any yaml or json configs into tui

ConfigUI

Turn YAML, JSON, and TOML configuration files into a terminal user interface (TUI) — no IDE required.

---

Installation

# Install from PyPI
uv tool install configui

# Or with pip
pip install configui

Quickstart

configui path/to/config.yaml

Open a configuration file in the interactive TUI editor. Edit values, toggle booleans, navigate nested structures — everything stays type-aware. Try it with the sample configs in samples/:

configui samples/training_config.yaml
configui samples/training_config.json
configui samples/training_config.toml

configui path/to/config.yaml -r  # Read-only mode

Features

• Type-aware editing — booleans become checkboxes, numbers get numeric inputs, nested objects become collapsible sections.
• Multi-format — YAML (with comment preservation via ruamel.yaml), JSON, and TOML (with tomlkit).
• Read-only mode — inspect configs without accidental edits (-r flag).
• Save or Save As — overwrite the original or write to a new path.
• Comment preservation — your YAML and TOML comments stay intact.

Supported Formats

Format	Library	Comments preserved
YAML	ruamel.yaml	✅
JSON	stdlib json	❌ (not supported by format)
TOML	tomlkit	✅

Development

uv tool install hatch
hatch run release   # fmt → typing → test with coverage

License

MIT