Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jmwoliver/hui
A visual alternative to the history command written in Rust
https://github.com/jmwoliver/hui
bash cli history ratatui rust zsh
Last synced: 22 days ago
JSON representation
A visual alternative to the history command written in Rust
- Host: GitHub
- URL: https://github.com/jmwoliver/hui
- Owner: jmwoliver
- Created: 2023-05-04T20:06:07.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-12-23T15:03:01.000Z (about 1 year ago)
- Last Synced: 2024-11-10T21:46:10.071Z (3 months ago)
- Topics: bash, cli, history, ratatui, rust, zsh
- Language: Rust
- Homepage:
- Size: 1.67 MB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# `hui` - A visual alternative to `history` written in Rust
## Overview
`hui` is command-line tool to quickly search through your terminal history. The motivation behind this tool was having a prettier and faster way to do `history | grep `. I would do this frequently to remember some `docker` or `curl`
command I had done recently, but couldn't remember the flags I used. This now lets me search through my history and copy the command I want a lot easier.
`hui` is built on top of [ratatui](https://github.com/tui-rs-revival/ratatui) for its TUI, or Terminal User Interface.
## Setup
### Installation
If you are on a Mac, you can install from `homebrew`:
```bash
brew tap jmwoliver/hui
brew install hui
```
Alternatively, you would like to install from source if you have `cargo` installed locally:
```bash
git clone https://github.com/jmwoliver/hui.git
cd hui
cargo build --release
# you can then alias the command so it is available in any directory:
# alias hui=/target/release/hui
```
### Configuration
After installing `hui`, it will need to know which shell you are using. This can be done by setting the `HUI_TERM` environment variable.
For `zsh`, run the following commands:
```bash
echo 'export HUI_TERM="zsh"' >> ~/.zshrc
source ~/.zshrc
```
If you are using `bash`, run:
```bash
echo 'export HUI_TERM="bash"' >> ~/.bashrc
source ~/.bashrc
```
Bash doesn't automatically write the history back to the `.bash_history` file like ZSH does. The following can be added to your `.bashrc` file to append the history for each command (based on a [StackExchange response](https://askubuntu.com/a/261411)):
```bash
unset HISTFILESIZE
HISTSIZE=3000
PROMPT_COMMAND="history -a"
export HISTSIZE PROMPT_COMMAND
shopt -s histappend
```
Then remember to:
```bash
source ~/.bashrc
```
## Usage
Once everything is installed and the `HUI_TERM` environment variable is set, all you have to do to run it is:
```
hui
```
Now you can scroll through all your history, filter results, and select a command to copy to your clipboard.
Enjoy!
## Acknowledgements
I used several projects for inspiration or guidance:
- [ratatui](https://github.com/tui-rs-revival/ratatui): Incredible TUI framework and useful examples
- [hstr-rs](https://github.com/overclockworked64/hstr-rs/tree/master): Helped me better understand how to ingest and parse the `.zsh_history` file
- [hoard](https://github.com/Hyde46/hoard): Similar concept to `hui` and I liked how they had the searchbar at the bottom