https://github.com/berquerant/help-bash-go

help-bash displays the things like documentation comments in .sh file.
https://github.com/berquerant/help-bash-go

go

Last synced: about 1 year ago
JSON representation

help-bash displays the things like documentation comments in .sh file.

• Host: GitHub
• URL: https://github.com/berquerant/help-bash-go
• Owner: berquerant
• License: mit
• Created: 2022-12-10T16:59:25.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-12-10T17:41:05.000Z (over 3 years ago)
• Last Synced: 2025-02-06T16:57:56.213Z (over 1 year ago)
• Topics: go
• Language: Go
• Homepage:
• Size: 11.7 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# help-bash-go

Clone of [help-bash](https://github.com/berquerant/help-bash) written in Go.

```

❯ ./help-bash -h

help-bash displays the things like documentation comments in .sh file.

USAGE:

  help-bash [OPTIONS] [PATH]

ARGS:

    

        A file to display documentations.

ENVIRONMENT VARIABLES:

     HELP_BASH_DEBUG

         If value is 1 then enables debug logs.

         If value is 2 then enables trace logs in addition to debug logs.

OPTIONS:

  -f    Displays top-level (outside of any statements) functions documentations.

  -r    Displays top-level variables documentations.

  -t uint

        Number of rows of which threshold to determine whether to display the top-level comments.

        e.g. the value is 3 then displays 3 or more lines of top-level comments. (default 3)

  -v    Prints version information.

```