Rich Enhanced Shell History - Contextual shell history for zsh and bash
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
resh/README.md

57 lines
2.2 KiB

[![Latest version](https://img.shields.io/github/v/tag/curusarn/resh?sort=semver)](https://github.com/curusarn/resh/releases)
[![Go Report Card](https://goreportcard.com/badge/github.com/curusarn/resh)](https://goreportcard.com/report/github.com/curusarn/resh)
[![Go test](https://github.com/curusarn/resh/actions/workflows/go.yaml/badge.svg)](https://github.com/curusarn/resh/actions/workflows/go.yaml)
[![Shell test](https://github.com/curusarn/resh/actions/workflows/sh.yaml/badge.svg)](https://github.com/curusarn/resh/actions/workflows/sh.yaml)
# RESH
Context-based replacement for `zsh` and `bash` shell history.
**Full-text search your shell history.**
Relevant results are displayed first based on current directory, git repo, and exit status.
<!-- Contextual shell history -->
<!-- Contextual bash history -->
<!-- Contextual zsh history -->
<!-- Context-based shell history -->
<!-- Context-based bash history -->
<!-- Context-based zsh history -->
<!-- Better shell history -->
<!-- Better bash history -->
<!-- Better zsh history -->
<!-- PWD Directory -->
## Install
Install RESH with one command:
```sh
curl -fsSL https://raw.githubusercontent.com/curusarn/resh/master/scripts/rawinstall.sh | sh
```
You will need to have `curl` and `tar` installed.
More options on [Installation page ⇗](./installation.md)
## Search your history
Press <kbd>Ctrl</kbd> + <kbd>R</kbd> to search:
<img width="906" alt="RESH search app screenshot" src="https://user-images.githubusercontent.com/10132717/221371937-d4ba64e0-ede6-4bfa-8b74-529252bf73a3.png">
### In-app key bindings
- Type to search
- <kbd>Up</kbd> / <kbd>Down</kbd> or <kbd>Ctrl</kbd> + <kbd>P</kbd> / <kbd>Ctrl</kbd> + <kbd>N</kbd> to select results
- <kbd>Enter</kbd> to execute selected command
- <kbd>Right</kbd> to paste selected command onto the command line so you can edit it before execution
- <kbd>Ctrl</kbd> + <kbd>C</kbd> or <kbd>Ctrl</kbd> + <kbd>D</kbd> to quit
- <kbd>Ctrl</kbd> + <kbd>G</kbd> to abort and paste the current query onto the command line
- <kbd>Ctrl</kbd> + <kbd>R</kbd> to search without context (toggle)
## Issues & ideas
Find help on [Troubleshooting page ⇗](./troubleshooting.md)
Problem persists? [Create an issue ⇗](https://github.com/curusarn/resh/issues)