Installation

With pip

Requires Python 3.10+.

$ pip install doccmd

With Homebrew (macOS, Linux, WSL)

Requires Homebrew.

$ brew tap adamtheturtle/doccmd
$ brew install doccmd

Pre-built Linux (x86) binaries

$ curl --fail -L "https://github.com/adamtheturtle/doccmd/releases/download/2025.04.08/doccmd-linux" -o /usr/local/bin/doccmd &&
    chmod +x /usr/local/bin/doccmd

Using doccmd as a pre-commit hook

To run doccmd with pre-commit, add hooks like the following to your .pre-commit-config.yaml:

-   repo: https://github.com/adamtheturtle/doccmd-pre-commit
    rev: v2025.04.08
    hooks:
    -   id: doccmd
        args: ["--language", "shell", "--command", "shellcheck --shell=bash"]
        additional_dependencies: ["shellcheck-py"]