See Also Annotation

@SeeAlso

This feature requires a minimum version of 3.0.0

The @SeeAlso annotation may be applied to classes and provides a see also section that will be included in Help as an additional section.

To use it simply add it like so:

@SeeAlso(
     internalCommands = { "my-cli my-other-cmd"},
     externalCommands = { "grep" }
)
public class MyClass { }

There are two fields, internalCommands and externalCommands each take a string array where one/more relevant commands are listed. The intent is that the former is used for referencing other commands within your CLI and the latter for commands provided by the OS, other software etc.

In terms of help rendering the practical difference is that commands listed in internalCommands array are listed prior to commands in the externalCommands array.

Improving this Documentation

This documentation is itself open source and lives in GitHub under the docs/ directory.

I am not a professional technical writer and as the developer of this software I can often make assumptions of knowledge that you as a user reading this may not have. Improvements to the documentation are always welcome, if you have suggestions for the documentation please submit pull requests to the main branch.