Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Autocompletion #22

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Update readme to represent auto completion
  • Loading branch information
Jonas Bernemann committed Aug 8, 2017
commit ee8c492923261097ed41e0f7c4f9725adcffe1fd
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -411,6 +411,11 @@ The creation of the `--help` option can be disabled by passing `null` as the
constructing a `HelpFormatter` instance. In the above example a
`DefaultHelpFormatter` was created with the prologue and epilogue.

## Auto Completion

To enable auto completion generation for bash & zsh you have to pass the parameter `autoCompletion` an instance of `DefaultAutoCompletion`.
If the argument `autoCompletion` is not null the arg parser will add the `--auto-completion` option.
If this option is present the program will halt and generate the script for bash/zsh.

## Caveats