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

shdoc is a tool for viewing and exporting documentation for shell scripts. The documentation format is described in the specification.

Usage Demo

Installation

From source

Make sure you have a working Go 1.25+ 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 shdoc, do:

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

Upgrading

Since version 0.11.0 you can update shdoc to the latest release using self-update feature:

shdoc --update

This command will runs a self-update in interactive mode. If you want to run a quiet update (no output), use the following command:

shdoc --update=quiet

Command-line completion

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

Bash:

shdoc --completion=bash | sudo tee /etc/bash_completion.d/shdoc > /dev/null

ZSH:

shdoc --completion=zsh | sudo tee /usr/share/zsh/site-functions/shdoc > /dev/null

Fish:

shdoc --completion=fish | sudo tee /usr/share/fish/vendor_completions.d/shdoc.fish > /dev/null

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