Installation

Install MinimalDoc on your system

Last updated: March 15, 2026

getting-startedinstallation

Installation

Prerequisites

  • Go 1.24 or later
  • Git (optional, for cloning)

Install from Source

git clone https://github.com/studiowebux/minimaldoc.git
cd minimaldoc
go build -o minimaldoc ./cmd/minimaldoc

Move the binary to your PATH:

# macOS/Linux
sudo mv minimaldoc /usr/local/bin/

# Or add to user bin
mv minimaldoc ~/.local/bin/

Go Install

go install github.com/studiowebux/minimaldoc/cmd/minimaldoc@latest

Ensure $GOPATH/bin is in your PATH.

Binary Releases

Download pre-built binaries from the releases page.

Available for:

  • Linux (amd64, arm64)
  • macOS (amd64, arm64)
  • Windows (amd64)

Verify Installation

minimaldoc --version

Expected output:

minimaldoc version 1.0.0

Shell Completion

Generate shell completions:

# Bash
minimaldoc completion bash > /etc/bash_completion.d/minimaldoc

# Zsh
minimaldoc completion zsh > "${fpath[1]}/_minimaldoc"

# Fish
minimaldoc completion fish > ~/.config/fish/completions/minimaldoc.fish

Next Steps