Installation

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

There are several ways to install OWASP Noir, so you can choose the method that works best for your operating system and workflow.

Homebrew (macOS and Linux)

If you are on macOS or Linux, the easiest way to install Noir is with Homebrew.

brew install noir

For Homebrew users, shell completions for Zsh, Bash, and Fish are automatically installed, so you can start using them right away.

Snapcraft (Linux)

If you are on a Linux distribution that supports Snap, you can install Noir from the Snap Store.

sudo snap install noir

Docker

If you prefer to use Docker, you can pull the official Noir image from the GitHub Container Registry (GHCR).

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

You can find a list of all available tags on the GitHub Packages page.

Build from Source

If you want to build Noir from source, you will need to have the 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.

‹ Getting Started

Running Noir ›