Skip to content

Commit

Permalink
Document shell autocompletion.
Browse files Browse the repository at this point in the history
  • Loading branch information
joaander committed Dec 4, 2024
1 parent f8d5c5c commit 5cdfce4
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions doc/src/guide/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,3 +58,22 @@ cargo install --path row --locked
```

Ensure that `$HOME/.cargo/bin` is on your `$PATH`.

## Configuring shell autocompletion

Execute the appropriate command in your shell's profile:
* Bash:
```shell
source <(COMPLETE=bash your_program)
```
* Fish:
```shell
source (COMPLETE=fish your_program | psub)
```
* Zsh:
```shell
source <(COMPLETE=zsh your_program)
```
For additional shell configurations, see [clap-complete's documentation].
[clap-complete's documentation]: https://docs.rs/clap_complete/latest/clap_complete/env/index.html

0 comments on commit 5cdfce4

Please sign in to comment.