Skip to content

Commit

Permalink
Add note about shell completion scripts
Browse files Browse the repository at this point in the history
  • Loading branch information
clubby789 committed May 10, 2023
1 parent 28dbeaf commit 9313fde
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions src/building/suggested.md
Original file line number Diff line number Diff line change
Expand Up @@ -339,3 +339,12 @@ pkgs.mkShell {
RUST_BOOTSTRAP_CONFIG = config;
}
```

## Shell Completions

If you use Bash, Fish or PowerShell, you can find automatically-generated shell completion scripts for `x.py` in [`src/etc/completions`](https://github.com/rust-lang/rust/tree/master/src/etc/completions).
Zsh support will also be included once issues with [`clap_complete`](https://crates.io/crates/clap_complete) have been resolved.

You can use `source ./src/etc/completions/x.py.<extension>` to load completions for your shell of choice,
or `source .\src\etc\completions\x.py.ps1` for PowerShell.
Adding this to your shell's startup script (e.g. `.bashrc`) will automatically load this completion.

0 comments on commit 9313fde

Please sign in to comment.