Install md-to-pdf¶

This guide shows you how to install the CLI from a GitHub Release or from this repository.

Install from a release archive¶

Download the archive for your platform from the latest release:

Choose the archive that matches your operating system and CPU. The names below use <tag> for the release tag, such as v0.1.3.

Platform	Archive
macOS Apple Silicon	`md-to-pdf-<tag>-aarch64-apple-darwin.zip`
macOS Intel	`md-to-pdf-<tag>-x86_64-apple-darwin.zip`
Linux x86_64	`md-to-pdf-<tag>-x86_64-unknown-linux-gnu.tar.gz`
Windows x86_64	`md-to-pdf-<tag>-x86_64-pc-windows-msvc.zip`

Download the matching .sha256 file too.

Install on macOS¶

Run:

curl -fsSL https://raw.githubusercontent.com/MiguelElGallo/md-to-pdf/main/scripts/install-macos.sh | sh

The installer detects Apple Silicon vs Intel, downloads the latest macOS archive and matching checksum, verifies the checksum, and installs md-to-pdf to /usr/local/bin.

To install a specific release instead of the latest one, set MD_TO_PDF_VERSION:

curl -fsSL https://raw.githubusercontent.com/MiguelElGallo/md-to-pdf/main/scripts/install-macos.sh | MD_TO_PDF_VERSION=v0.1.3 sh

Check the release notes for the current macOS signing and notarization status.

Confirm the command is available:

md-to-pdf --help

If the shell cannot find md-to-pdf, open a new terminal or check that /usr/local/bin is on your PATH.

Verify and install on Linux¶

Run:

VERSION="vX.Y.Z" # replace with the tag of the release you downloaded
shasum -a 256 -c "md-to-pdf-${VERSION}-x86_64-unknown-linux-gnu.sha256"
tar -xzf "md-to-pdf-${VERSION}-x86_64-unknown-linux-gnu.tar.gz"
sudo install "md-to-pdf-${VERSION}-x86_64-unknown-linux-gnu/md-to-pdf" /usr/local/bin/md-to-pdf
md-to-pdf --help

Verify and run on Windows¶

Run in PowerShell:

$version = "vX.Y.Z" # replace with the tag of the release you downloaded
$archive = ".\md-to-pdf-$version-x86_64-pc-windows-msvc.zip"
Get-FileHash $archive -Algorithm SHA256
Expand-Archive $archive
.\md-to-pdf-$version-x86_64-pc-windows-msvc\md-to-pdf.exe --help

Open the matching .sha256 file and confirm its hash matches the Get-FileHash output before running the executable.

Install from source¶

Run:

cargo install --path .

Confirm the command is available:

md-to-pdf --help

Build without installing¶

For development, run:

cargo build

Then run the binary through Cargo:

cargo run -- fixtures/basic.md --output /tmp/basic.pdf