midenup 1.0.0

The Miden toolchain manager
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131

# Installation

## Installing midenup

1. Install the Miden toolchain installer (midenup) using cargo:

```shell title=">_ Terminal"
cargo install midenup
```

2. Initialize the midenup environment:

```shell title=">_ Terminal"
midenup init
```

The `midenup init` command initializes the `$MIDENUP_HOME` directory and creates a `miden`
symlink in `$CARGO_HOME/bin` (default `~/.cargo/bin`). The `miden` command then routes to the
active toolchain components for you.

## Configure PATH Environment Variable

**This is a critical step!** You must ensure the directory containing the `miden` symlink is in
your shell `$PATH`. In a standard Rust install that is `$CARGO_HOME/bin`, which defaults to
`~/.cargo/bin`. `midenup` will automatically display the required commands if it detects that
`miden` is not accessible from the `$PATH`.

If you use a custom `CARGO_HOME`, replace the paths below accordingly.

### For Zsh (macOS default)

Add the following to your `~/.zprofile` file. If the file does not exist yet, create it first:

```bash title=">_ Terminal"
touch ~/.zprofile
echo 'export PATH="$HOME/.cargo/bin:$PATH"' >> ~/.zprofile
```

If you prefer to edit the file manually, add:

```bash title=">_ Terminal"
export PATH="$HOME/.cargo/bin:$PATH"
```

Then reload your shell configuration:

```bash title=">_ Terminal"
source ~/.zprofile
```

### For Bash

Add the following to your `~/.bash_profile` file (use `~/.bashrc` on Linux). If the file does
not exist yet, create it first:

```bash title=">_ Terminal"
touch ~/.bash_profile
echo 'export PATH="$HOME/.cargo/bin:$PATH"' >> ~/.bash_profile
```

If you prefer to edit the file manually, add:

```bash title=">_ Terminal"
export PATH="$HOME/.cargo/bin:$PATH"
```

Then reload your shell configuration:

```bash title=">_ Terminal"
source ~/.bash_profile
```

:::warning Critical Step
If you forget to do the step above, some functionality will not work as expected!
:::

### For PowerShell (Windows)

:::note todo
Add instructions here
:::

## Install the Miden Toolchain

After initializing `midenup`, install the Miden toolchain:

```bash title=">_ Terminal"
midenup install mainnet
```

This installs the toolchain currently deployed to mainnet: the versions of all Miden components that work together on that network.

## Verify Installation

1. Check that midenup is working:

```bash title=">_ Terminal"
midenup show active-toolchain
```

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

```text
mainnet
```

</details>


2. Verify that the `miden` command is available:

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

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

```text
The Miden toolchain porcelain

Help:
  help                   Print this help message
  help toolchain         Print help about the currently available aliases and components *
  help <COMPONENT>       Print a specific <COMPONENTS>'s help message *

*: These commands will install the currently present toolchain if not installed.
```

</details>