Skip to content

docs: fix installation PATH instructions for midenup #225

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
BrianSeong99 merged 1 commit into from
Mar 21, 2026
Merged

docs: fix installation PATH instructions for midenup #225

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 11 additions & 34 deletions docs/builder/get-started/setup/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,31 +98,23 @@ Until published to crates.io, install using: `cargo install --git https://github
midenup init
```

This creates the `$MIDENUP_HOME` directory and sets up symlinks for the `miden` command.
This creates the `$MIDENUP_HOME` directory and sets up the `miden` command by creating a symlink in your Cargo bin directory (`$CARGO_HOME/bin/`, typically `~/.cargo/bin/`). Since Rust users already have this directory in their PATH, no additional PATH configuration is needed.

**Configure PATH**

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

```bash title=">_ Terminal"
midenup show home
which miden
```

Then add it to your shell configuration:

**For Zsh (macOS default):**
<details>
<summary>Expected output</summary>

```bash title="~/.zshrc"
export PATH="/Users/$(whoami)/Library/Application Support/midenup/bin:$PATH"
source ~/.zshrc
```text
/Users/<USERNAME>/.cargo/bin/miden # macOS
/home/<USERNAME>/.cargo/bin/miden # Linux
```

**For Bash:**

```bash title="~/.bashrc"
export PATH="$XDG_DATA_DIR/midenup/bin:$PATH"
source ~/.bashrc
```
</details>

**Install Miden Toolchain**

Expand All @@ -149,19 +141,6 @@ stable

</details>

```bash title=">_ Terminal"
which miden
```

<details>
<summary>Expected output</summary>

```text
/Users/<USERNAME>/Library/Application Support/midenup/bin/miden
```

</details>

Test by creating a new project:

```bash title=">_ Terminal"
Expand All @@ -174,12 +153,10 @@ If successful, you'll see a new directory with Miden project files.

**"miden: command not found"**

This means the PATH isn't configured correctly. Verify midenup's bin directory is in your PATH:
Ensure `$CARGO_HOME/bin` (typically `~/.cargo/bin/`) is in your PATH. This should already be configured if you installed Rust via rustup. Verify with:

```bash title=">_ Terminal"
echo $PATH | grep midenup
echo $PATH | tr ':' '\n' | grep cargo
```

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

---
Loading