Repository navigation
Installation
curl -fsSL https://github.com/mdink-rs/mdink/releases/latest/download/install.sh | bashThe script downloads the appropriate binary for your platform and places it in ~/.local/bin (or /usr/local/bin when run as root).
| Variable | Purpose | Example |
|---|---|---|
VERSION |
Pin a specific release | VERSION=v0.1.1 bash install.sh |
BIN_DIR |
Override install directory | BIN_DIR=~/.local/bin bash install.sh |
Requires Rust 1.86 or later.
cargo install mdinkTo install a specific version:
cargo install mdink@0.2.1cargo install --git https://github.com/mdink-rs/mdinkDownload the .deb from the Releases page and install it:
curl -LO https://github.com/mdink-rs/mdink/releases/latest/download/mdink_0.1.1_amd64.deb
sudo dpkg -i mdink_0.1.1_amd64.debThe package installs the binary, man page, and shell completions automatically.
- Download
mdink-windows-x86_64.zipfrom the Releases page. - Extract the archive.
- Add the extracted folder to your
PATH(System → Advanced system settings → Environment variables).
Note: Windows Terminal does not support Sixel or Kitty image protocols. Images render as half-block art. Use
--no-imagesto suppress them.
The shell completion files are included in the .deb package. For other install methods, generate them manually:
# bash
mdink --generate-completions bash > ~/.local/share/bash-completion/completions/mdink
# zsh (place anywhere in $fpath)
mdink --generate-completions zsh > ~/.zfunc/_mdink
# fish
mdink --generate-completions fish > ~/.config/fish/completions/mdink.fishIf your build does not include
--generate-completions, grab the pre-built files fromassets/completions/in the repository.
The man page (mdink.1) is installed automatically by the .deb package.
For other install methods, download it from the release assets and install manually:
curl -LO https://github.com/mdink-rs/mdink/releases/latest/download/mdink.1.gz
sudo install -m 644 mdink.1.gz /usr/share/man/man1/Then view it with:
man mdink