Installation

With pip

Requires Python 3.10+.

$ pip install doccmd

With Homebrew (macOS, Linux, WSL)

Requires Homebrew.

$ brew tap adamtheturtle/doccmd
$ brew install doccmd

With winget (Windows)

Requires winget.

$ winget install --id adamtheturtle.doccmd --source winget --exact

The winget package may not be the latest version.

Pre-built Linux (x86) binaries

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

Pre-built macOS (ARM) binaries

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

You may need to remove the quarantine attribute to run the binary:

$ xattr -d com.apple.quarantine /usr/local/bin/doccmd

Pre-built Windows binaries

Download the Windows executable from the latest release and place it in a directory on your PATH.

With Docker

$ docker run --rm -v "$(pwd):/workdir" -w /workdir "ghcr.io/adamtheturtle/doccmd" --help

With Nix

Requires Nix.

$ nix --extra-experimental-features 'nix-command flakes' run "github:adamtheturtle/doccmd/2026.01.31.3" -- --help

To avoid passing --extra-experimental-features every time, enable flakes permanently.

Or add to your flake inputs:

{
  inputs.doccmd.url = "github:adamtheturtle/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: v2026.01.31.3
    hooks:
    -   id: doccmd
        args: ["--language", "shell", "--command", "shellcheck --shell=bash"]
        additional_dependencies: ["shellcheck-py"]