From 4ad649a8c0dd0a191a724777f3dcc25447adfb2c Mon Sep 17 00:00:00 2001 From: clubby789 Date: Wed, 10 May 2023 21:16:19 +0100 Subject: [PATCH] Add note about shell completion scripts --- src/building/suggested.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/src/building/suggested.md b/src/building/suggested.md index 8cf9891b6..9dcc795f2 100644 --- a/src/building/suggested.md +++ b/src/building/suggested.md @@ -339,3 +339,13 @@ 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.` +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. \ No newline at end of file