Installation

Installing nctl, the Nirmata CLI

The Nirmata CLI is available on Linux, macOS, and Windows.

Homebrew

Download and install the latest stable release of the notation CLI on macOS, Linux, or Windows Subsystem for Linux (WSL) using Homebrew:

Install

brew tap nirmata/nctl
brew install nctl

Verify

You can verify the nctl installaton by checking its version:

nctl version

Upgrade

brew upgrade nctl

Uninstall

brew uninstall nctl
brew untap nirmata/nctl

Binary download

Download the latest stable release of the Nirmata CLI binary.

Set the NCTL_VERSION environment variable to the version of nctl you want to download. For example, if the latest version is 4.3.1

export NCTL_VERSION=4.3.1

Linux

For ARM processors:

curl -LO https://dl.nirmata.io/nctl/nctl_$NCTL_VERSION/nctl_$NCTL_VERSION\_linux_arm64.zip
curl -LO https://dl.nirmata.io/nctl/nctl_$NCTL_VERSION/nctl_$NCTL_VERSION\_linux_arm64.zip.asc

For x86 processors:

curl -LO https://dl.nirmata.io/nctl/nctl_$NCTL_VERSION/nctl_$NCTL_VERSION\_linux_amd64.zip
curl -LO https://dl.nirmata.io/nctl/nctl_$NCTL_VERSION/nctl_$NCTL_VERSION\_linux_amd64.zip.asc

MacOS

For ARM processors:

curl -LO https://dl.nirmata.io/nctl/nctl_$NCTL_VERSION/nctl_$NCTL_VERSION\_macos_arm64.zip
curl -LO https://dl.nirmata.io/nctl/nctl_$NCTL_VERSION/nctl_$NCTL_VERSION\_macos_arm64.zip.asc

For x86 processors:

curl -LO https://dl.nirmata.io/nctl/nctl_$NCTL_VERSION/nctl_$NCTL_VERSION\_macos_amd64.zip
curl -LO https://dl.nirmata.io/nctl/nctl_$NCTL_VERSION/nctl_$NCTL_VERSION\_macos_amd64.zip.asc

Windows

curl -LO https://dl.nirmata.io/nctl/nctl_$NCTL_VERSION/nctl_$NCTL_VERSION\_windows_64-bit.zip
curl -LO https://dl.nirmata.io/nctl/nctl_$NCTL_VERSION/nctl_$NCTL_VERSION\_windows_64-bit.zip.asc

Verify the download

To verify the signature of a Nirmata download:

Download the Nirmata PGP key (see below)
Use gpg to verify the download integrity

export GNUPGHOME="$(mktemp -d)"
gpg --keyserver keys.openpgp.org --recv-key 7CEE8D12BCFE419B55A5D66A4F71AE57094A908B
gpg --batch --verify <ASC_FILE> <ARCHIVED_ZIP_FILE>

For a download with a valid signature, the above commands will show an output with a line:

gpg: Good signature from "Nirmata Security <security@nirmata.com>"

To secure communications and verify downloads, you can use the following PGP key. You can also fetch this key from the keys.openpgp.org key server with the ID 7CEE8D12BCFE419B55A5D66A4F71AE57094A908B.

key

Install the CLI binary

nctl is a precompiled binary. It is distributed as a zip archive. After download, unzip the downloaded package. You can then set permissions and move the binary into a directory in your PATH.

unzip <ZIP_FILE>
chmod u+x nctl
sudo mv nctl /usr/local/bin/nctl

Verify the installation

You can verify the nctl installaton by checking its version:

nctl version

Upgrade

Upgrade nctl to stay up-to-date with the supported features, follow these steps:

Check the version of installed binary and compare with the latest stable release to see if an update is required:

nctl version

If the installed binary is out-dated, remove previous installation of nctl:

rm -rf /usr/local/bin/nctl

Delete the .asc and .zip file downloaded at the time of install.
Download the latest release of nctl binary and install it as described above in the installation instructions.
After installing, check the version of the newly installed binary:

nctl version

Uninstall

Follow these steps to uninstall nctl:

Remove the installed nctl binary:

rm -rf /usr/local/bin/nctl

Remove the .asc and .zip file downloaded at the time of install.

This is the final element on the page and there should be no margin below this.