Skip to content

[Feature]: show plugins option (--verbose?) to show plugin source URI/http uri - as there is no plugin documentation. #2184

@metimocyn

Description

@metimocyn

Expected behavior

$ bash-it show plugins --verbose

Plugin               Enabled?   Description              Reference
alias-completion     [ ]                                 https://github.com/Bash-it/bash-it/blob/master/completion/available/aliases.completion.bash
autojump             [ ]        Autojump                 https://github.com/wting/autojump
aws                  [ ]        AWS helper functions     https://github.com/Bash-it/bash-it/blob/master/plugins/available/aws.plugin.bash
base                 [x]        miscellaneous tools      https://github.com/Bash-it/bash-it/blob/master/plugins/available/base.plugin.bash
....

or something like:

$ bash-it show plugins --verbose

Plugin               Enabled?   Description              
alias-completion     [ ]
                                  https://github.com/Bash-it/bash-it/blob/master/completion/available
autojump             [ ]        Autojump
                                  https://github.com/wting/autojump
aws                  [ ]        AWS helper functions
                                  https://github.com/Bash-it/bash-it/blob/master/plugins/available/aws.plugin.bash
base                 [x]        miscellaneous tools
                                  https://github.com/Bash-it/bash-it/blob/master/plugins/available/base.plugin.bash
....

Current behavior

$ bash-it show plugins

Plugin               Enabled?   Description
alias-completion     [ ]        
autojump             [ ]        Autojump configuration, see https://github.com/wting/autojump for more details
aws                  [ ]        AWS helper functions
base                 [x]        miscellaneous tools
....

Possible solution

add a reference/doc variable to each plugin so that users can look into the details of the plugin and what it does.

Context

No response

Notes

No response

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions