README.md

Usage Demo • Installation • Usage • Test & Coverage Status • Contributing • License

shdoc is a tool for viewing and exporting documentation for shell scripts.

Usage Demo

Installation

From source

Make sure you have a working Go 1.21+ workspace (instructions), then:

go install github.com/essentialkaos/shdoc@latest

Prebuilt binaries

You can download prebuilt binaries for Linux and macOS from EK Apps Repository.

To install the latest prebuilt version of bibop, do:

bash <(curl -fsSL https://apps.kaos.st/get) shdoc

Command-line completion

You can generate completion for bash, zsh or fish shell.

Bash:

sudo shdoc --completion=bash 1> /etc/bash_completion.d/shdoc

ZSH:

sudo shdoc --completion=zsh 1> /usr/share/zsh/site-functions/shdoc

Fish:

sudo shdoc --completion=fish 1> /usr/share/fish/vendor_completions.d/shdoc.fish

Usage

Test & Coverage Status

Branch	CI	Coveralls
master
develop

Contributing

Before contributing to this project please read our Contributing Guidelines.

License

Apache License, Version 2.0