Install UCF Tools

The latest UCF tool release can be downloaded from https://registry.ngc.nvidia.com/orgs/eevaigoeixww/teams/ucf-20-ea-release/resources/ucf_tools/files

After downloading the package using the link above, run:

$ sudo apt remove ucf-tools  # remove old version
$ rm -rf ~/.ucf_workspace/ ~/.cache/ucf_registry/ # Clear old cache
$ rm ~/.config/ucf/registry.toml # Remove old config file
$ sudo apt install libyaml-cpp-dev python3-yaml
$ sudo dpkg -i ucf_tools_2.0.0_ubuntu22.04_190d7bf.deb

## It installs tools to /opt/nvidia/ucf-tools

Get the NGC API Key - Refer to Generating Your NGC API Key

Setup NGC API Key

NGC_API_KEY=<NGC_API_KEY>
ucf_app_builder_cli registry repo set-api-key -a $NGC_API_KEY
ucf_app_builder_cli registry repo sync -n <REPO_NAME>

Verify the installation

MS Builder

$ ucf_ms_builder_cli --help
usage: ucf_ms_builder_cli [-h] [-v] [-va]  ...

positional arguments:

    service           Perform actions on a microservice
    registry          Perform actions on registry
    component         Perform actions on components

optional arguments:
  -h, --help          show this help message and exit
  -v, --version       Print MS Builder Version
  -va, --version-all  Print all versions

$ ucf_ms_builder_cli --version
Version:
        MS Builder: v2.0.0

$ ucf_ms_builder_cli --version-all
Versions:
        MS Builder: v2.0.0
        UCF MS Spec: v2.0.0

App Builder

$ ucf_app_builder_cli --help
usage: ucf_app_builder_cli [-h] [-v] [-va]  ...

positional arguments:

    app               Perform actions on apps
    service           Perform actions on a microservice

optional arguments:
  -h, --help          show this help message and exit
  -v, --version       Print MS Builder Version
  -va, --version-all  Print all versions

$ ucf_app_builder_cli --version
Version:
        App Builder: v2.0.0

$ ucf_app_builder_cli --version-all
Versions:
        App Builder: v2.0.0
        UCF MS Spec: v2.0.0