Installation

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

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.

Install the latest Nargo

Run noirup to install the latest stable release:

noirup

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>

noirup --version nightly

noirup --branch <branch-name>

noirup --repo <username/repo>

noirup --repo <username/repo> --branch <branch-name>

noirup --pr <pr-number>

noirup -C <commit-hash>

noirup --path ./path/to/local/source

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

# Add to ~/.zshrc:
# fpath=(~/.zsh/completions $fpath)
# autoload -U compinit
# compinit

mkdir -p ~/.zsh/completions
nargo generate-completion-script zsh > ~/.zsh/completions/_nargo

nargo generate-completion-script bash > /usr/local/etc/bash_completion.d/nargo

mkdir ~/.bash_completions/
nargo generate-completion-script bash > ~/.bash_completions/nargo.bash
# Then add to ~/.bash_profile or ~/.bashrc:
# source ~/.bash_completions/nargo.bash

nargo generate-completion-script fish > ~/.config/fish/completions/nargo.fish

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.

Get Started

Language Guide

Standard Library

Tooling

Installation

Install Nargo

Update Nargo

Install a specific version

Set up shell completions

Uninstall Nargo

​Install Nargo

​Update Nargo

​Install a specific version

​Set up shell completions

​Uninstall Nargo

Install Nargo

Update Nargo

Install a specific version

Set up shell completions

Uninstall Nargo