Installation

Learn how to install OWASP Noir on your system. This guide provides instructions for installing Noir using Homebrew, Snapcraft, Docker, Nix, or by building from source.

Choose your preferred installation method:

Homebrew (macOS and Linux)

Install using Homebrew:

brew install noir

Shell completions for Zsh, Bash, and Fish are automatically installed.

Snapcraft (Linux)

Install from Snap Store:

sudo snap install noir

Docker

Pull from GitHub Container Registry:

docker pull ghcr.io/owasp-noir/noir:latest

See all available tags on the GitHub Packages page.

Nix

Install using Nix:

nix profile add github:owasp-noir/noir

**Tip:** In Docker or restricted environments, you may need to enable experimental features: ```bash nix --extra-experimental-features "nix-command flakes" profile add github:owasp-noir/noir ```

Or run directly:

nix run github:owasp-noir/noir -- -h

Direct Binary Download

You can download the latest prebuilt binaries directly from the GitHub Releases page.

Download the appropriate archive for your platform (for example, noir-linux-x86_64.tar.gz or noir-macos-universal.tar.gz).
Extract the archive:
```
tar xzf noir-*.tar.gz
```
Move the noir binary somewhere on your PATH, for example:
```
sudo mv noir /usr/local/bin/
```
Verify the installation:
```
noir --version
```

Debian Package (.deb)

For Debian and Ubuntu (or derivatives), you can install Noir using the .deb package from the GitHub Releases page.

Download the latest .deb package (for example, noir_latest_amd64.deb):

wget https://github.com/owasp-noir/noir/releases/latest/download/noir_latest_amd64.deb

Install the package:
```
sudo dpkg -i noir_latest_amd64.deb
```
If there are missing dependencies, fix them with:
```
sudo apt-get -f install
```
Verify the installation:
```
noir --version
```

Unofficial

Arch AUR

Install from AUR:

yay -S noir

Build from Source

Requires Crystal programming language installed.

Clone the repository:

git clone https://github.com/owasp-noir/noir
cd noir

Install dependencies:
```
shards install
```
Build the project:
```
shards build --release --no-debug
```
The compiled binary will be located at ./bin/noir.

Verifying the Installation

Once you have installed Noir, you can verify that it is working correctly by running:

noir --version

This should print the installed version of Noir.