termsearch 0.3.0

A minimalist and super fast terminal history search tool.
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
68

# termsearch

[![pipeline](https://github.com/zenoxygen/termsearch/actions/workflows/ci.yaml/badge.svg)](https://github.com/zenoxygen/termsearch/actions/workflows/ci.yaml)
[![crates.io](https://img.shields.io/crates/v/termsearch.svg)](https://crates.io/crates/termsearch)

A minimalist and super fast terminal history search tool, that uses a weighted scoring system to rank commands.

- Recency: more recent commands are given higher priority
- Frequency: commands used more frequently are given higher priority

*Note: it only works with `zsh` on Linux for now.*

## Usage

### Initialize termsearch

Add the following line to your `~/.zshrc` file:

```bash
eval "$(termsearch init)"
```

This rebinds **Ctrl+R** to use termsearch for searching your command history.

### Search for a command

```
termsearch search
```

- **Up/Down** and **Shift+Tab/Tab** navigate up/down through the search results.
- **Enter** selects the highlighted command and pastes it into the terminal's input line.
- **Ctrl+C**, **Ctrl+D**, **Esc** cancel the search.

### Options

```
-m, --max-history <MAX_HISTORY>  Maximum number of history lines to read [default: 10000]
-r, --max-results <MAX_RESULTS>  Maximum number of results to display [default: 10]
```

## Installation

### From crates.io (recommended)

```bash
cargo install termsearch
```

### From source

```bash
cargo install --path .
```

## Uninstallation

```bash
cargo uninstall termsearch
```

## Debug

Set log level with `TERMSEARCH_LOG` environment variable:

```bash
export TERMSEARCH_LOG=debug
```