Skip to main content
Version: 0.11 (stable)

Installation

This guide walks you through installing the Miden development tools using the midenup toolchain manager.

Prerequisites​

Install Rust​

Miden development requires Rust. Install it using rustup:

>_ Terminal
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y

Reload your PATH environment variable:

>_ Terminal
. "$HOME/.cargo/env"

Verify the installation:

>_ Terminal
rustc --version
Expected output
rustc 1.92.0-nightly (fa3155a64 2025-09-30)

Install Node.js & Yarn​

For TypeScript development with the Miden Web Client, you'll need Node.js and Yarn.

Install Node.js:

>_ Terminal
# Install Node.js using the official installer or package manager
# For macOS with Homebrew:
brew install node

# For Ubuntu/Debian:
curl -fsSL https://deb.nodesource.com/setup_lts.x | sudo -E bash -
sudo apt-get install -y nodejs

# For Windows, download from nodejs.org

Install Yarn:

>_ Terminal
# Install Yarn globally via npm
npm install -g yarn

Verify installations:

>_ Terminal
node --version && yarn --version
Expected output
v20.11.0
1.22.19

Install Miden CLI​

Install midenup

The Miden toolchain installer makes it easy to manage Miden components:

>_ Terminal
cargo install midenup

Until published to crates.io, install using: cargo install --git https://github.com/0xMiden/midenup.git

Initialize midenup

>_ Terminal
midenup init

This creates the $MIDENUP_HOME directory and sets up symlinks for the miden command.

Configure PATH

Add the midenup bin directory to your PATH. First, check your current $MIDENUP_HOME:

>_ Terminal
midenup show home

Then add it to your shell configuration:

For Zsh (macOS default):

~/.zshrc
export PATH="/Users/$(whoami)/Library/Application Support/midenup/bin:$PATH"
source ~/.zshrc

For Bash:

~/.bashrc
export PATH="$XDG_DATA_DIR/midenup/bin:$PATH"
source ~/.bashrc

Install Miden Toolchain

Install the latest stable Miden components:

>_ Terminal
midenup install stable

Initialize Miden Client

Configure the client for the network you'll use:

>_ Terminal
miden-client init --network testnet

Available networks:

  • testnet - Miden's public test network
  • devnet - Development network
  • localhost - Local node for testing

Verify Installation​

Check that everything is working correctly:

>_ Terminal
midenup show active-toolchain
Expected output
stable
>_ Terminal
which miden
Expected output
/Users/<USERNAME>/Library/Application Support/midenup/bin/miden

Test by creating a new project:

>_ Terminal
miden new my-test-project

If successful, you'll see a new directory with Miden project files.

Troubleshooting​

"miden: command not found"

This means the PATH isn't configured correctly. Verify midenup's bin directory is in your PATH:

>_ Terminal
echo $PATH | grep midenup

If missing, re-add the export command to your shell configuration and reload it.