NVIDIA
NGC CLI
Resource
NVIDIA
NGC CLI

NGC CLI

  • Windows 64-bit Install

    The NGC CLI binary for Windows is supported on Windows Vista and later.

    Download the CLI installer, then check the installer's SHA256 hash to ensure the file wasn't corrupted during download. Run the following command to get the SHA256 hash:

    $ Get-FileHash .\ngccli_win_amd64.exe
    

    Then compare with the following value, which can also be found in the Release Notes of the Resource:

    7a805902100082aebe29f9c1148c807de807afd8b7c817134a777249070cc225
    

    After verifying value, double-click the downloaded file to launch the NVIDIA installer and follow the instructions in the installer.

    You must configure NGC CLI for your use so that you can run the commands.

    Enter the following command and follow the prompts:

    $ ngc config set
    

    Windows 64-bit Uninstall:

    Uninstall using Windows Add/Remove Programs.

    AMD64 Linux Install

    The NGC CLI binary for Linux is supported on Ubuntu 16.04 and later distributions.

    Click Download CLI to download the zip file that contains the binary, then transfer the zip file to a directory where you have permissions and then unzip and execute the binary. You can also download, unzip, and install from the command line by moving to a directory where you have execute permissions and then running the following command:

    $ wget --content-disposition https://api.ngc.nvidia.com/v2/resources/nvidia/ngc-apps/ngc_cli/versions/4.34.10/files/ngccli_linux.zip -O ngccli_linux.zip && unzip ngccli_linux.zip
    

    Check the binary's md5 hash to ensure the file wasn't corrupted during download:

    $ find ngc-cli/ -type f -exec md5sum {} + | LC_ALL=C sort | md5sum -c ngc-cli.md5
    

    Check the binary's SHA256 hash to ensure the file wasn't corrupted during download. Run the following command

    $ sha256sum ngccli_linux.zip
    

    Compare with the following value, which can also be found in the Release Notes of the Resource:

    58bc4d7b6901551a095ce5a43a0065b1c22d5eaf1a164d40029ee3fda11ccd47
    

    After verifying value, make the NGC CLI binary executable and add your current directory to path:

    $ chmod u+x ngc-cli/ngc
    $ echo "export PATH=\"\$PATH:$(pwd)/ngc-cli\"" >> ~/.bash_profile && source ~/.bash_profile
    

    You must configure NGC CLI for your use so that you can run the commands.

    Enter the following command, including your API key when prompted:

    $ ngc config set
    

    Linux Uninstall:

    Warning: If you choose to have a custom path for your installation, or move the CLI Binary, these instructions may not be safe.

    For CLI versions 3.0.0 and up:

    1. Check dirname `which ngc`.

    If this directory can be deleted, move to the next step. If not, move to step 3.

    1. Delete the NGC CLI directory:

    Enter the following command.

    $ dirname `which ngc` | xargs rm -r
    
    1. Delete the NGC CLI Binary. Enter the following command.
    $ which ngc | xargs rm
    

    This does not delete all files downloaded from the initial NGC CLI installation. Please go to the original installation folder and delete it.

    ARM64 Linux Install

    The NGC CLI binary for ARM64 is supported on Ubuntu 18.04 and later distributions.

    Click Download CLI to download the zip file that contains the binary, then transfer the zip file to a directory where you have permissions and then unzip and execute the binary. You can also download, unzip, and install from the command line by moving to a directory where you have execute permissions and then running the following command:

    $ wget --content-disposition https://api.ngc.nvidia.com/v2/resources/nvidia/ngc-apps/ngc_cli/versions/4.34.10/files/ngccli_arm64.zip -O ngccli_arm64.zip && unzip ngccli_arm64.zip
    

    Check the binary's md5 hash to ensure the file wasn't corrupted during download:

    $ find ngc-cli/ -type f -exec md5sum {} + | LC_ALL=C sort | md5sum -c ngc-cli.md5
    

    Check the binary's SHA256 hash to ensure the file wasn't corrupted during download. Run the following command

    $ sha256sum ngccli_arm64.zip
    

    Compare with the following value, which can also be found in the Release Notes of the Resource:

    5c18c5d14ad9e4b8c8ac0b5c596cd4ed33c1e4a3f2bd93f851eb974a6f3f6847
    

    After verifying value, make the NGC CLI binary executable and add your current directory to path:

    $ chmod u+x ngc-cli/ngc
    $ echo "export PATH=\"\$PATH:$(pwd)/ngc-cli\"" >> ~/.bash_profile && source ~/.bash_profile
    

    You must configure NGC CLI for your use so that you can run the commands.

    Enter the following command, including your API key when prompted:

    $ ngc config set
    

    ARM64 Uninstall:

    Warning: If you choose to have a custom path for your installation, or move the CLI Binary, these instructions may not be safe.

    For CLI versions 3.0.0 and up:

    1. Check dirname `which ngc`.

    If this directory can be deleted, move to the next step. If not, move to step 3.

    1. Delete the NGC CLI directory:

    Enter the following command.

    $ dirname `which ngc` | xargs rm -r
    
    1. Delete the NGC CLI Binary. Enter the following command.
    $ which ngc | xargs rm
    

    This does not delete all files downloaded from the initial NGC CLI installation. Please go to the original installation folder and delete it.

    macOS Intel Installer

    The NGC CLI binary for macOS is supported on macOS 10.13 and later.

    Click Download CLI to download the installer or use the following command to download the installer:

    $ curl -LO https://api.ngc.nvidia.com/v2/resources/nvidia/ngc-apps/ngc_cli/versions/4.34.10/files/ngccli_mac_intel.pkg
    

    Check the installer's SHA256 hash to ensure the file wasn't corrupted during download. Run the following command to get the SHA256 Checksum:

    $ shasum -a 256 ngccli_mac_intel.pkg
    

    Then compare with the following value, which can also be found in the Release Notes of the Resource:

    661d384684ec511e89eae52fac03d9847454fafa2fb7ef313a554bf03858d8e1
    

    After verifying value, run installer to install CLI:

    $ sudo installer -pkg ngccli_mac_intel.pkg -target /usr/local
    

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

    $ export LC_ALL=en_US.UTF-8
    

    You must configure NGC CLI for your use so that you can run the commands.

    $ ngc config set
    

    macOS Intel Uninstall

    Remove the binary file and it's dependencies:

    $ sudo rm -rf /usr/local/ngc-cli/ /usr/local/bin/ngc
    

    macOS ARM Installer

    The NGC CLI binary for macOS is supported on macOS 10.13 and later.

    Click Download CLI to download the installer or use the following command to download the installer:

    $ curl -LO https://api.ngc.nvidia.com/v2/resources/nvidia/ngc-apps/ngc_cli/versions/4.34.10/files/ngccli_mac_arm.pkg
    

    Check the installer's SHA256 hash to ensure the file wasn't corrupted during download. Run the following command to get the SHA256 Checksum:

    $ shasum -a 256 ngccli_mac_arm.pkg
    

    Then compare with the following value, which can also be found in the Release Notes of the Resource:

    3ee5283c8c301144a722b8304e511ddaf7edb520b3e932ae5a393aa3c9433502
    

    After verifying value, run installer to install CLI:

    $ sudo installer -pkg ngccli_mac_arm.pkg -target /usr/local
    

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

    $ export LC_ALL=en_US.UTF-8
    

    You must configure NGC CLI for your use so that you can run the commands.

    $ ngc config set
    

    macOS ARM Uninstall

    Remove the binary file and it's dependencies:

    $ sudo rm -rf /usr/local/ngc-cli/ /usr/local/bin/ngc