UBLX

Ublx ... Safe when taken as directed.

TUI that turns a directory into a flat, navigable catalog — index once, enrich on demand, browse in the terminal. Indexing uses Nefaxer; deep metadata uses ZahirScan when you enhance.

In active development — expect breaking changes.

Install

Homebrew

brew tap Latka-Industries/ublx https://github.com/Latka-Industries/UBLX
brew install Latka-Industries/ublx/ublx

Homebrew builds with the embedded serve UI (--features ui).

Cargo

cargo install ublx

crates.io builds are API-only (ublx serve without the Leptos SPA). The embedded UI needs a full checkout: run ./crates/ublx-web/build.sh, then cargo install --path . --features ui (or use Homebrew, which does that).

Quick start

ublx /path/to/your/project

Headless index: ublx --snapshot-only /path/to/project · Full metadata: ublx --full-snapshot

Catalog CLI (after an index exists):

ublx query . --categories
ublx query . --category Code --json
ublx query . --path src/main.rs --zahir
ublx doctor .
ublx doctor --fix .    # remove leftover tmp/wal/shm (blocked while a snapshot is writing)

See ublx --help, ublx query --help, ublx doctor --help.

Documentation

Full guides, config tables, TUI keys, and workflows live on the docs site (README here stays minimal).


Install	Homebrew, Cargo, prerequisites, first run
CLI	`ublx --help`, headless flags, `query` / `doctor`
Configuration	`ublx.toml`, enhance policies, themes
TUI & modes	Snapshot, Delta, Lenses, panes, keybindings
Guides	Path-only vs enhance, headless export, lenses
FAQ	Common questions
API (docs.rs)	Rust crate reference

Not a file manager — for that, see yazi. UBLX targets project trees: fast catalogs, previews, diffs, and export.

License

Dual-licensed under MIT or Apache-2.0.