Install the CLI

Our Python SDK also includes our CLI tool nu. You can use nu to easily access information about your Nucleus Datasets and Models right from your favorite shell.

We recommend installing it with pipx. This way, the nu CLI will install such that it can be accessed even from within other virtualenvs.

To install pipx on MacOS:

brew install pipx
pipx ensurepath

Otherwise, install pipx via pip (requires pip 19.0 or later):

python3 -m pip install --user pipx
python3 -m pipx ensurepath

Then install nu with

pipx install scale-nucleus

The CLI tool listens to the same environment variable recommended to set up in Authentication. We also recommend you start by installing shell completions that are available for bash, zsh and fish.

export NUCLEUS_API_KEY=<your_api_key>

nu install-completion

When running nu you should be greeted with


  Nucleus CLI (nu)

      ███╗   ██╗██╗   ██╗ ██████╗██╗     ███████╗██╗   ██╗███████╗
      ████╗  ██║██║   ██║██╔════╝██║     ██╔════╝██║   ██║██╔════╝
      ██╔██╗ ██║██║   ██║██║     ██║     █████╗  ██║   ██║███████╗
      ██║╚██╗██║██║   ██║██║     ██║     ██╔══╝  ██║   ██║╚════██║
      ██║ ╚████║╚██████╔╝╚██████╗███████╗███████╗╚██████╔╝███████║
      ╚═╝  ╚═══╝ ╚═════╝  ╚═════╝╚══════╝╚══════╝ ╚═════╝ ╚══════╝

      `nu` is a command line interface to interact with Scale Nucleus

  --web   Launch browser
  --help  Show this message and exit.

  datasets            Datasets are the base collections of items in Nucleus
  install-completion  Install shell completion script to your rc file
  jobs                Jobs are a wrapper around various long-running...
  models              Models help you store and access your ML model data
  reference           View the Nucleus reference documentation in the...
  slices              Slices are named subsets of Datasets
  tests               Scenario Tests allow you to test your Models