Installation

Learn how to install, update, and remove the Meldoc CLI.

Install

macOS / Linux / WSL

curl -fsSL https://meldoc.io/install.sh | bash

Windows PowerShell

irm https://meldoc.io/install.ps1 | iex

Windows CMD

curl -fsSL https://meldoc.io/install.cmd -o install.cmd && install.cmd && del install.cmd

The installer picks the right build for your platform and installs it under your home directory, so no sudo is needed.

Install flow

1. Detect your platform (operating system and architecture).
2. Download the binary from the GitHub releases page.
3. Verify its SHA256 checksum.
4. Place the binary at the install path.
5. Configure your PATH — skipped with --no-path-setup.
6. Run the setup wizard — skipped with --no-setup, and when the install came through a pipe.

Install paths

Platform	Default path
macOS / Linux / WSL (user install)	~/.local/bin/meldoc
macOS / Linux / WSL (--global)	/usr/local/bin/meldoc
Windows	%LOCALAPPDATA%\Programs\meldoc\bin\meldoc.exe

Installer flags

Flag	Description
--global	Install to /usr/local/bin (requires sudo)
--dir <path>	Install to a custom directory
--version <ver>	Install a specific version (e.g., v1.0.0)
--force	Overwrite an existing installation
--no-path-setup	Skip PATH configuration
--no-setup	Skip the interactive setup wizard (useful for CI/CD)
--quiet	Minimal output

PATH configuration

On macOS, Linux and WSL the installer appends the install directory to your shell config — .zshrc, .bashrc, or Fish’s config.fish. Source that file or open a new terminal for it to take effect.

On Windows it adds the binary directory to your user PATH in the registry (HKCU\Environment).

If you installed with --no-path-setup, set the PATH up yourself — see Troubleshoot PATH below.

Verify installation

After installing, confirm the CLI is available:

meldoc version

Keep in mind: Restart your terminal and IDE (VS Code, Cursor, etc.) after installing so the updated PATH takes effect.

Run the setup wizard

The setup wizard configures PATH, MCP for your IDE, and optional login. It runs automatically during an interactive install. If you installed via a pipe (curl ... | bash), the wizard can’t run in that context — open a new terminal and run:

meldoc setup

You can re-run the wizard anytime with the same command.

Update

The recommended way to update:

meldoc updateVersion

meldoc updateVersion fetches the latest published release and compares it with the version you’re running. If you’re already up to date, it says so and exits successfully. Otherwise it shows both versions and asks for confirmation, then downloads the new binary, verifies its SHA256 checksum, and replaces the running executable in place. On Windows it also makes sure the binary directory is still on your PATH.

To update without confirmation:

meldoc updateVersion --force

Keep in mind: A development build (one that reports its version as dev) can’t update itself. meldoc updateVersion exits with code 1 in that case — reinstall with the install script instead.

You can also re-run the install script with --force:

curl -fsSL https://meldoc.io/install.sh | bash -s -- --force

Uninstall

curl -fsSL https://meldoc.io/uninstall.sh | bash

Or remove the binary manually:

# User install
rm ~/.local/bin/meldoc

# Global install
sudo rm /usr/local/bin/meldoc

Manual download

Download binaries from the GitHub releases page:

Platform	Archive
Linux 64-bit	meldoc-VERSION-linux-amd64.tar.gz
Linux ARM64	meldoc-VERSION-linux-arm64.tar.gz
macOS Intel	meldoc-VERSION-darwin-amd64.tar.gz
macOS Apple Silicon	meldoc-VERSION-darwin-arm64.tar.gz
Windows 64-bit	meldoc-VERSION-windows-amd64.zip
Windows ARM64	meldoc-VERSION-windows-arm64.zip

Verify the checksum

Every release publishes a SHA256SUMS file alongside the binaries. The install script and meldoc updateVersion check it for you; verify a manual download yourself:

VERSION="v1.0.0"
curl -fsSL "https://github.com/meldoc-io/meldoc-cli/releases/download/${VERSION}/SHA256SUMS" -o SHA256SUMS

# Linux
sha256sum -c SHA256SUMS --ignore-missing

# macOS
shasum -a 256 -c SHA256SUMS --ignore-missing

Troubleshoot PATH

If meldoc: command not found after installation, your shell hasn’t picked up the new PATH entry.

Option 1: Open a new terminal window. This is the most common fix.

Option 2: Run the setup wizard using the full path to the binary:

~/.local/bin/meldoc setup

Option 3: Add the directory to your shell config manually:

# zsh
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.zshrc && source ~/.zshrc

# bash
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc && source ~/.bashrc

# Fish
fish_add_path ~/.local/bin

For more help, see Troubleshooting.

What’s next?

Quick Start — Get your first document published in minutes.

Configuration — Configure the CLI for your project.