nctl

nctl is a command line interface (CLI) for the Nirmata platform.

Download

Download the latest release of nctl by selecting your operating system and architecture below:

Follow these instructions to verify the download signature that was created using Nirmata’s PGP key.

You can also download other versions of nctl in the Stable GA Releases section. Refer to the nctl release notes for getting detailed information of the changes made on the different releases.

Installation

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 nctl_1.0.2_linux_64-bit.zip
chmod u+x nctl
sudo mv nctl /usr/local/bin/nctl

Test the installation using the command:

nctl version

Usage

To use nctl, you will need a Nirmata account and an API access key. To sign in to your account, use the nctl login command:

λ nctl login
This command will store your credentials on this device and is not recommended for use on shared devices.
Alternatively, you can use global flags or set the NIRMATA_TOKEN and NIRMATA_URL environment variables.
Enter Nirmata address [https://nirmata.io]:
Enter email: jim@nirmata.com
Enter API key: *** redacted ***

Validating user credentials...done!
Wrote configuration to C:\Users\jbugwadia\.nirmata\config

To view all nctl commands, simply type nctl and hit enter. Learn more about the different commands from the official nctl documentation.

λ nctl
nctl is the command line interface for Nirmata

Usage:
  nctl [flags]
  nctl [command]

Available Commands:
  add         Add resources to NPM
  clusters    Manage Kubernetes clusters
  completion  Generate the autocompletion script for the specified shell
  describe    Describe NPM cluster
  edit        Edit nctl resources
  get         Get (or list) NPM resources
  help        Help about any command
  info        Account and User Information
  install     Install nirmata components
  login       Sign in to Nirmata Policy Manager
  raw         Direct access to the Nirmata REST API
  register    Register resources to NPM
  remediate   Remediate resources for policy violations
  remove      Remove NPM resources
  scan        Scan resources
  transform   Transform resource manifests to json
  uninstall   Remove nirmata components
  update      Update NPM resources
  upgrade     Upgrade nirmata components
  version     Show version and build information

Flags:
  -h, --help      help for nctl
  -v, --v Level   log level for V logs

Use "nctl [command] --help" for more information about a command.