Fleet Command CLI

Fleet Command also offers a powerful command-line interface (CLI) that wraps the API in a familiar and user-friendly way that allows users and administrators to build against the Fleet Command.

When a user needs to automate tasks and has a workflow that they have to do repeatedly, they will want to write a script. Also, some tasks just make more sense to do via programming. For example, if you’re creating/editing a deployment where you need to add/remove 100s or 1000s of locations, clicking checkboxes with the mouse becomes unmanageable. Furthermore, some workflows include many steps which can be wrapped into single scripts or functions within scripts. Future workflows that we haven’t thought of can also be created by end-users using the CLI.

Many power users will expect the ability to work from the command line instead of navigating a UI. This allows you to do things in an administrative workflow that would be difficult with the UI. For example, assume something comes up, and you need to edit all of your existing locations with a change. This is trivial when calling the CLI from a script but would be more tedious to do in the UI.

Installing the CLI

Reference NGC Registry User Guide for instructions on NGC and NGC Registry CLI use.

OS Specific Install/Uninstall

These instructions should always be current, but it is best to start with the instructions directly from within NGC > Setup > CLI download.

Linux

Download

wget -O ngccli_reg_linux.zip https://ngc.nvidia.com/downloads/ngccli_reg_linux.zip && unzip -o ngccli_reg_linux.zip && chmod u+x ngc

Add to PATH

echo "export PATH=\"\$PATH:$(pwd)\"" >> ~/.bash_profile && source ~/.bash_profile

Uninstall

rm `which ngc`

macOS

Download

curl -O https://ngc.nvidia.com/downloads/ngccli_reg_mac.zip && unzip ngccli_reg_mac.zip && chmod u+x ngc

Setup localization correctly in your shell:

Make sure that you have a localization setup to support UTF-8 by setting LC_ALL in ~/.bash_profile. For example:

export LC_ALL=en_US.UTF-8

Add to PATH

echo "export PATH=\"\$PATH:$(pwd)\"" >> ~/.bash_profile && source ~/.bash_profile

Uninstall

rm `which ngc` && hash -d ngc

Windows

Download

Download the installer, then double-click the downloaded file to launch the NVIDIA installer and follow the instructions in the installer.

Uninstall

Use Windows Add/Remove Programs.

CLI commands

The NGC Fleet Command CLI provides commands for the following areas:

Command Group

Description

apikey

Fleet Command API Key Commands

appconfig

Fleet Command Application Configuration Commands

application

Fleet Command Application Commands

component

Fleet Command Component Commands

deployment

Fleet Command Deployment Commands

location

Fleet Command Location Commands

log

Fleet Command Log Commands

settings

Fleet Command Settings Commands

usage

Fleet Command GPU Usage Commands

For the latest CLI commands and options, refer to Fleet Command CLI.

Sample Workflows

For a list of sample workflows, refer to Fleet Command Example Workflows.