Help of Bash Complemention about airline HOT 5 CLOSED

To support Bash completion you need to do the following:

• Add @CompletionBehaviour annotations to options/arguments that need them. Note that you don't have to add these annotations at all as the basic annotations provide enough information to generate a basic Bash completion script
• Create an instance of BashCompletionGenerator and parse your GlobalMetadata to it:
  BashCompletionGenerator<Object> generator = new BashCompletionGenerator<>(); generator.usage(metadata, output);
  This dumps the completion script to some OutputStream instance here specified by the output variable. Typically you will want this to be a FileOutputStream
• You then need to source the script in your environment

I will leave this open as this definitely needs to be added to the new User Guide which I am currently working on - http://rvesse.github.io/airline/guide/ (#35)

from airline.

Thanks a lot. I tried but stuck at constructing GlobalMetadata object. Is there some example on GlobalMetadata?

from airline.

If you have created a parser for your CLI (i.e. you have a Cli instance) then you can simply call getMetadata() on this to get the meta-data. We don't currently have a way to generate completion for a SingleCommand instance

from airline.

Hoping to get a complete version of the User Guide prepared in the coming months so adding this to the next milestone

from airline.

Now documented at http://rvesse.github.io/airline/guide/help/bash.html

from airline.