Install Meldoc CLI

Sync documentation between your Git repository and the Meldoc platform. Publish, pull, and keep docs in sync with one command.

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

After installing, restart your terminal and IDE (VS Code, Cursor, etc.) so the updated PATH takes effect.

Optional

Run setup in a new terminal to configure MCP for your IDE and log in:

$ meldoc setup

If meldoc is not in your PATH yet, run the exact command shown at the end of the install output (full path + setup).

If meldoc is not in your PATH

Sometimes the installer does not add the install directory to PATH (e.g. non-standard shell or --no-path-setup). Add it manually so the meldoc command is available:

zsh (macOS default):

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

bash:

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

Or add export PATH="$HOME/.local/bin:$PATH" to ~/.profile (or your shell config), then open a new terminal.

What the installer does

  • Detects your platform and architecture automatically
  • Downloads the latest version of the CLI binary
  • Verifies file integrity via SHA256 checksum
  • Installs to ~/.local/bin/meldoc (no sudo needed)
  • Adds install directory to your PATH by default (Unix: shell config; Windows: registry)
  • Runs the setup wizard (PATH, MCP, login) if in an interactive terminal

Install options

--global Install to /usr/local/bin (requires sudo)
--no-path-setup Do not add to PATH (default: adds to shell config)
--version <ver> Install specific version (e.g. v1.0.0)
--quiet Minimal output, suitable for CI/CD
--force Overwrite existing installation (also used for updates)
--dir <path> Install to a custom directory
--no-setup Skip interactive setup wizard (useful for CI/CD)

Quick start

Basic workflow
$ meldoc init
$ meldoc push --token YOUR_TOKEN
$ meldoc pull --token YOUR_TOKEN

Run meldoc --help for the full command reference.

Ready to keep docs in sync?