Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/noir-lang/noir/llms.txt

Use this file to discover all available pages before exploring further.

Nargo is the command-line tool for developing Noir programs. It handles project scaffolding, compilation, execution, testing, and more. The recommended way to install Nargo is via noirup.

Install Nargo

1

Install noirup

Run the install script to fetch noirup and add it to your shell:
curl -L https://raw.githubusercontent.com/noir-lang/noirup/refs/heads/main/install | bash
On Windows, Nargo must be installed inside Windows Subsystem for Linux (WSL). The default backend (Barretenberg) does not provide native Windows binaries.
2

Install the latest Nargo

Run noirup to install the latest stable release:
noirup
3

Verify the installation

Confirm that Nargo is installed and on your PATH:
nargo --version
You should see output like nargo version = 1.0.0-beta.x.

Update Nargo

To update to the latest stable release, run noirup again at any time:
noirup

Install a specific version

noirup lets you install any published release, a nightly build, or even build from source.
noirup --version <version>

Set up shell completions

Once Nargo is installed, you can enable tab completions for the nargo command. Generate the completion script for your shell using:
nargo generate-completion-script [shell]
where [shell] is one of: bash, elvish, fish, powershell, or zsh.
nargo generate-completion-script zsh > ~/.oh-my-zsh/completions/_nargo

Uninstall Nargo

If you installed Nargo with noirup, remove its directories to fully uninstall it:
rm -r ~/.nargo
rm -r ~/nargo
rm -r ~/noir_cache
This removes all installed Nargo binaries, configurations, and cached files.

Build docs developers (and LLMs) love