Install the notation CLI

Install the notation CLI on Linux, macOS, and Windows

Download and install the CLI for Linux

Homebrew

Download the latest stable release of the notation CLI on Linux using Homebrew:

brew install notation

Binary download

Download the latest stable release of the notation CLI binary for Linux and checksum file, then verify the integrity of the download.

Set the NOTATION_VERSION environment variable to the version of notation you want to download. The latest version is 1.0.1.

export NOTATION_VERSION=1.0.1

For ARM processors:

curl -LO https://github.com/notaryproject/notation/releases/download/v$NOTATION_VERSION/notation_$NOTATION_VERSION\_linux_arm64.tar.gz
curl -LO https://github.com/notaryproject/notation/releases/download/v$NOTATION_VERSION/notation_$NOTATION_VERSION\_checksums.txt
shasum --check notation_$NOTATION_VERSION\_checksums.txt

For x86 processors:

curl -LO https://github.com/notaryproject/notation/releases/download/v$NOTATION_VERSION/notation_$NOTATION_VERSION\_linux_amd64.tar.gz
curl -LO https://github.com/notaryproject/notation/releases/download/v$NOTATION_VERSION/notation_$NOTATION_VERSION\_checksums.txt
shasum --check notation_$NOTATION_VERSION\_checksums.txt

Confirm the shasum command succeeds for the archive file you downloaded. For example, the following shows a successful checksum verification for the notation_1.0.1_linux_arm64.tar.gz archive file:

...
shasum: notation_1.0.1_windows_amd64.zip: No such file or directory
notation_1.0.1_windows_amd64.zip: FAILED open or read
shasum: notation_1.0.1_linux_amd64.tar.gz: No such file or directory
notation_1.0.1_linux_amd64.tar.gz: FAILED open or read
notation_1.0.1_linux_arm64.tar.gz: OK
shasum: notation_1.0.1_darwin_amd64.tar.gz: No such file or directory
notation_1.0.1_darwin_amd64.tar.gz: FAILED open or read
shasum: notation_1.0.1_darwin_arm64.tar.gz: No such file or directory
notation_1.0.1_darwin_arm64.tar.gz: FAILED open or read
shasum: WARNING: 4 listed files could not be read
...

Expand the archive file directly into /usr/bin/:

tar xvzf <ARCHIVE_FILE> -C /usr/bin/ notation

Alternatively, you can expand the archive file to a different directory and add it to your path. For example, the following command expands the archive file to <EXAMPLE_PATH>/notation-cli/ and adds it to your path using the PATH variable in ~/.bashrc.

tar xvzf <ARCHIVE_FILE> -C <EXAMPLE_PATH>/notation-cli/ notation
echo 'export PATH="$PATH:<EXAMPLE_PATH>/notation-cli/"' >> ~/.bashrc

Download and install the CLI for macOS

Homebrew

Download the latest stable release of the notation CLI on macOS using Homebrew:

brew install notation

Binary download

Download the latest stable release of the notation CLI binary for macOS and checksum file, then verify the integrity of the download.

Set the NOTATION_VERSION environment variable to the version of notation you want to download. The latest version is 1.0.1.

export NOTATION_VERSION=1.0.1

For Apple Silicon processors:

curl -LO https://github.com/notaryproject/notation/releases/download/v$NOTATION_VERSION/notation_$NOTATION_VERSION\_darwin_arm64.tar.gz
curl -LO https://github.com/notaryproject/notation/releases/download/v$NOTATION_VERSION/notation_$NOTATION_VERSION\_checksums.txt
shasum --check notation_$NOTATION_VERSION\_checksums.txt

For Intel processors:

curl -LO https://github.com/notaryproject/notation/releases/download/v$NOTATION_VERSION/notation_$NOTATION_VERSION\_darwin_amd64.tar.gz
curl -LO https://github.com/notaryproject/notation/releases/download/v$NOTATION_VERSION/notation_$NOTATION_VERSION\_checksums.txt
shasum --check notation_$NOTATION_VERSION\_checksums.txt

Confirm the shasum command succeeds for the archive file you downloaded. For example, the following shows a successful checksum verification for the notation_1.0.1_darwin_amd64.tar.gz archive file:

...
shasum: notation_1.0.1_windows_amd64.zip: No such file or directory
notation_1.0.1_windows_amd64.zip: FAILED open or read
shasum: notation_1.0.1_linux_amd64.tar.gz: No such file or directory
notation_1.0.1_linux_amd64.tar.gz: FAILED open or read
shasum: notation_1.0.1_linux_arm64.tar.gz: No such file or directory
notation_1.0.1_linux_arm64.tar.gz: FAILED open or read
notation_1.0.1_darwin_amd64.tar.gz: OK
shasum: notation_1.0.1_darwin_arm64.tar.gz: No such file or directory
notation_1.0.1_darwin_arm64.tar.gz: FAILED open or read
shasum: WARNING: 4 listed files could not be read
...

Expand the archive file directly into /usr/local/bin:

sudo tar xvzf <ARCHIVE_FILE> -C /usr/local/bin/ notation

Alternatively, you can expand the archive file to a different directory and add it to your path. For example, the following command expands the archive file to <EXAMPLE_PATH>/notation-cli/ and adds it to your path using the PATH variable in ~/.zshhrc.

tar xvzf <ARCHIVE_FILE> -C <EXAMPLE_PATH>/notation-cli/ notation
echo 'export PATH="$PATH:<EXAMPLE_PATH>/notation-cli/"' >> ~/.zshrc

Download and install the CLI for Windows

WinGet

Download the latest stable release of the notation CLI on Windows using WinGet (Windows package manager):

winget install notation -s winget

.exe download

Download the latest stable release of the notation CLI binary for Windows and checksum file:

Use the Get-FileHash command in powershell to generate the hash of the archive file.

(Get-FileHash .\notation_1.0.1_windows_amd64.zip).Hash

Compare the results of the command with the value in the checksum file. The two values should match.

Expand the archive file and add notation.exe to %ProgramFiles%/notation/bin

Alternatively, you can expand the archive file to a different directory and add it to your path.

Additional configuration

For more on the NOTATION_CONFIG directory and configuring your environment with notation see:

Last modified November 10, 2023 : chore: update the installation guide and banner to v1.0.1 (#365) (781ca22)