Install codalotl

Choose your platform and architecture. Then follow the command to place the binary on your PATH.

macOS

Install via Homebrew

brew install codalotl/tap/codalotl

Downloads

Apple Silicon (arm64) Intel (amd64)

Saved to ~/Downloads by default.

Unzip

sudo unzip ~/Downloads/codalotl-0.1.0-darwin-arm64.zip -d /usr/local/bin

Configure

Configure Keys

codalotl config

Add documentation to a package

cd path/to/packge && codalotl doc .

Linux

Install via Homebrew

brew install codalotl/tap/codalotl

Downloads

x86_64 (amd64) ARM64

Saved to ~/Downloads by default.

Unpack

sudo tar -xvzf ~/Downloads/codalotl-0.1.0-linux-amd64.tgz -C /usr/local/bin

Configure

Configure Keys

codalotl config

Add documentation to a package

cd path/to/packge && codalotl doc .

Windows

Downloads

x64 (amd64) ARM64

Saved to Downloads by default.

Install

Unzip and move codalotl.exe to your PATH

Configure Keys

codalotl config

Add documentation to a package

cd path/to/packge && codalotl doc .