chest-rs 0.2.0

A multiplatform CLI command organizer
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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142

<div class="oranda-hide">

# Chest


</div>

Chest is a multi-platform CLI Command organizer inspired by hoard and built in Rust.

It allows you to save commands that are too complicated or long to remember.
When you add a command to chest, it remembers:
- a name for the command
- the command
- a description you provide

Next time you need a command, search for it using chest's search feature to quickly find it again.

<a name="toc" id="toc"/>

## [Table of contents](#)


<div class="oranda-hide" style="margin-bottom: -12px">

- [Install](#install)

</div>

- [Shell integration](#shell-integration)
- [Usage](#usage)
- [Keybindings](#keybindings)

<a name="install" id="install"/>

<div class="oranda-hide">

## [Install](#toc)

Current release: 0.2.0

### Using crates.io

Set up a Rust toolchain using [rustup](https://rustupers/), then run the following command.
```
cargo install chest-rs --locked --profile=dist
```

### Using cargo-binstall

Install [cargo-binstall](https://crates.io/crates/cargo-binstall), then run the following command.
```
cargo binstall chest-rs
```

### Using Github Releases

Archive formats and script installers are available in [Github Releases](https://github.com/Dauthdaert/chest/releases). Make sure the installed executable is in your PATH.

</div>

<a name="shell-integration" id="shell-integration"/>

## [Shell Integration](#toc)

Install `chest` as a plugin to enable deeper shell integration.

#### Nushell

Run the following command.
```
chest init nu | save ~/init-chest.nu
```
Then add the following to your Nushell config file.
```
source ~/init-chest.nu
```
<a name="usage" id="usage"/>

## [Usage](#toc)

### Add

In order to add a command to your chest database, use the following command.
```
chest add
```
You will be prompted to fill in the necessary information.

### Update

In order to update a command in your chest database, use the following command.
```
chest update
```
You will be prompted to fill in the updated information.

### Remove/Delete

In order to remove a command from your chest database, use the following command.
```
chest remove
```
You will be prompted for the name of the command to remove.

A delete alias is also provided.
```
chest delete
```

### Search

Once a command has been added to your chest, there are two ways to search for it.
#### Non-interactive search

Using the following command, the top 5 commands that match the query are returned.
```
chest search <QUERY>
```
#### Interactive search

Using the following command, a TUI opens that allows for interactive searching.
```
chest search --interactive
```
Optionnally, a query can be added in order to populate the search box with an initial search term.
```
chest search --interactive <QUERY>
```

Finally, if chest is installed as a **shell plugin**, interactive search is available through a keybinding (default Ctrl-h).
Additionaly, if chest is invoked through the keybinding, confirming a selection adds the selected command to your next prompt.

### Reset

If you get a database error after an update, it may be necessary to reset your saved commands. You can do so using the following command.
```
chest reset
```

<a name="keybindings" id="keybindings"/>

## [Keybindings](#toc)

#### Open from shell

```
<Ctrl-h>
```
#### Next or previous command in list
```
<Up-arrow> or <Down-arrow>
```
#### Select a command
```
<Enter>
```
#### Cancel selection and close chest
```
<Esc> or <Ctrl-c>
```