@@ -40,6 +40,7 @@ or with Docker:
4040$ alias completely=' docker run --rm -it --user $(id -u):$(id -g) --volume "$PWD:/app" dannyben/completely'
4141```
4242
43+
4344## Configuration syntax
4445
4546Completely works with a simple YAML configuration file as input, and generates
@@ -246,6 +247,7 @@ The rules here are as follows:
246247 hash key (e.g., `+--branch` or `"*--branch"`). Note that when using a `*`,
247248 the hash key must be quoted since asterisks have special meaning in YAML.
248249
250+
249251# # Using the generated completion scripts
250252
251253In order to enable the completions, simply source the generated script :
@@ -268,6 +270,7 @@ Alternatively, you can copy the script manually to one of these directories
268270- ` /usr/local/etc/bash_completion.d`
269271- ` ~/.local/share/bash-completion/completions`
270272
273+
271274# # Testing and debugging completion scripts
272275
273276You can use the built in completions script tester by running `completely test`.
@@ -305,6 +308,7 @@ puts completions.wrapper_function "custom_function_name"
305308p completions.tester.test "mygit status "
306309` ` `
307310
311+
308312# # Completions in ZSH
309313
310314If you are using Oh-My-Zsh, bash completions should already be enabled,
@@ -317,6 +321,17 @@ autoload -Uz +X compinit && compinit
317321autoload -Uz +X bashcompinit && bashcompinit
318322` ` `
319323
324+ # # Customizing the `complete` command
325+
326+ In case you wish to customize the `complete` command call in the generated
327+ script, you can do so by adding any additional flags to the `completely.yaml`
328+ configuration file using the special `completely_options` key. For example :
329+
330+ ` ` ` yaml
331+ completely_options:
332+ complete_options: -o nosort
333+ ` ` `
334+
320335# # Contributing / Support
321336
322337If you experience any issue, have a question or a suggestion, or if you wish
0 commit comments