Skip to content
metaoryPublic

About

Find the tool you installed and what it does

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

23 stars

Watchers

0 watching

Forks

Latest commit

 

History

9 Commits

Folders and files

Repository files navigation

logo

treg

Find the tool you installed and what it does

fuzzy-matches name, description, or category.
Descriptions come from man pages, a local tldr cache, `.desktop` files, pacman.
Your edits in `~/.config/treg/tools.toml` survive every re-index.

Demo

You have tons of tools installed many with weird names that you forget it next week

Installation

Prebuilt binaries

Grab an archive from Releases

Platform Target
Linux x86_64 x86_64-unknown-linux-musl
Linux arm64 aarch64-unknown-linux-musl
macOS Intel x86_64-apple-darwin
macOS Apple aarch64-apple-darwin
Windows x86_64-pc-windows-msvc
target=x86_64-unknown-linux-musl
curl -fsSL "https://github.com/metaory/treg/releases/latest/download/treg-$target.tar.gz" \
  | tar xz -C ~/.local/bin treg

Windows archives are .zip

From source

Requires a Rust toolchain (edition 2024)

cargo install --git https://github.com/metaory/treg

Usage

treg                                        # open the TUI
treg index                                  # re-index $PATH
treg list                                   # name, description, category
treg add qbt "torrent client" Network       # add or override a tool
treg prune                                  # drop tools whose binary is gone

The index cache is $XDG_DATA_HOME/treg/index.json (~/.local/share/treg/index.json). Your edits stay in $XDG_CONFIG_HOME/treg/tools.toml.

Key Action
type search
↑ / ↓, ^p / ^n move
PageUp / PageDown jump
Enter edit the description
^e edit the category
^a add a tool
^r re-index
Esc clear the query, then quit; cancel an edit
^c quit

In an editor, ^u clears back to the cursor.

Development

cargo run                                              # run the TUI
cargo test --locked                                    # unit tests
cargo fmt --check                                      # rustfmt
cargo clippy --locked --all-targets -- -D warnings     # clippy, pedantic included

A release is a tag vX.Y.Z whose version matches Cargo.toml. The workflow checks formatting, clippy and tests, then uploads the five targets above.

License

MIT

About

Find the tool you installed and what it does

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

23 stars

Watchers

0 watching

Forks

Releases

Used by

Contributors

Languages