ublx 0.1.8

TUI to index once, enrich with metadata, and browse a flat snapshot in a 3-pane layout with multiple modes.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67

# UBLX

[![Crates.io](https://img.shields.io/crates/v/ublx.svg)](https://crates.io/crates/ublx)
[![docs.rs](https://img.shields.io/docsrs/ublx)](https://docs.rs/ublx)
![Build](https://github.com/Latka-Industries/UBLX/workflows/Build/badge.svg)
![Rust](https://img.shields.io/badge/rust-1.95-orange.svg)

_[Ublx ... Safe when taken as directed.][ubik]_

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

**In active development — expect breaking changes.**

## Install

### Homebrew

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

### Cargo

```bash
cargo install ublx
```

## Quick start

```bash
ublx /path/to/your/project
```

Headless index: `ublx --snapshot-only /path/to/project` · Full metadata: `ublx --full-snapshot` · See `ublx --help`.

## Documentation

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

|                               |                                               |
| ----------------------------- | --------------------------------------------- |
| **[Install][ublx-gs]**        | Homebrew, Cargo, prerequisites, first run     |
| [CLI][ublx-cli]               | `ublx --help`, headless flags                 |
| [Configuration][ublx-config]  | `ublx.toml`, enhance policies, themes         |
| [TUI & modes][ublx-tui]       | Snapshot, Delta, Lenses, panes, keybindings   |
| [Guides][ublx-guides]         | Path-only vs enhance, headless export, lenses |
| [FAQ][ublx-faq]               | Common questions                              |
| **[API (docs.rs)][ublx-api]** | Rust crate reference                          |

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

## License

Dual-licensed under [MIT](LICENSE-MIT) or [Apache-2.0](LICENSE-APACHE).

[ubik]: https://bookshop.org/p/books/ubik-philip-k-dick/1fc432e3ade32290
[nefaxer]: https://github.com/Latka-Industries/nefaxer
[zahirscan]: https://github.com/Latka-Industries/zahirscan
[yazi]: https://github.com/sxyazi/yazi
[ublx-gs]: https://ublx.dev/getting-started
[ublx-cli]: https://ublx.dev/cli
[ublx-config]: https://ublx.dev/configuration
[ublx-tui]: https://ublx.dev/tui/
[ublx-guides]: https://ublx.dev/guides/
[ublx-faq]: https://ublx.dev/guides/faq
[ublx-api]: https://docs.rs/ublx