From 71718c267c1a70a3ffe35f8c9512fbd8b67ff516 Mon Sep 17 00:00:00 2001 From: Sean Breckenridge Date: Sun, 5 Mar 2023 14:57:15 -0800 Subject: [PATCH] update completion docs to make source path clear --- misc/completion/README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/misc/completion/README.md b/misc/completion/README.md index 699e27e..344387a 100644 --- a/misc/completion/README.md +++ b/misc/completion/README.md @@ -10,21 +10,23 @@ eval "$(_HPI_COMPLETE=fish_source hpi)" # in ~/.config/fish/config.fish That is slightly slower since its generating the completion code on the fly -- see [click docs](https://click.palletsprojects.com/en/8.0.x/shell-completion/#enabling-completion) for more info -To use the completions here: +To use the generated completion files in this repository, you need to source the file in `./bash`, `./zsh`, or `./fish` depending on your shell. + +If you don't have HPI cloned locally, after installing `HPI` you can generate the file yourself using one of the commands above. For example, for `bash`: `_HPI_COMPLETE=bash_source hpi > ~/.config/hpi_bash_completion`, and then source it like `source ~/.config/hpi_bash_completion` ### bash -Put `source /path/to/bash/_hpi` in your `~/.bashrc` +Put `source /path/to/hpi/repo/misc/completion/bash/_hpi` in your `~/.bashrc` ### zsh You can either source the file: -`source /path/to/zsh/_hpi` +`source /path/to/hpi/repo/misc/completion/zsh/_hpi` ..or add the directory to your `fpath` to load it lazily: -`fpath=("/path/to/zsh/" "${fpath[@]}")` (Note: the directory, not the script `_hpi`) +`fpath=("/path/to/hpi/repo/misc/completion/zsh/" "${fpath[@]}")` (Note: the directory, not the script `_hpi`) If your zsh configuration doesn't automatically run `compinit`, after modifying your `fpath` you should: