NeMo Microservices CLI#

The NeMo Microservices CLI (nmp) is a command-line tool for interacting with NeMo Microservices. It provides a unified interface for managing models, running jobs, deploying inference endpoints, and working with the local quickstart environment.

Key Capabilities#

  • API Operations - Manage models, jobs, workspaces, and other resources

  • Local Deployment - Start and manage the quickstart environment with a single command

  • Multiple Output Formats - Table, JSON, YAML, CSV, and Markdown for integration with other tools

  • Context Management - Switch between multiple environments (dev, staging, prod) seamlessly

  • Shell Completion - Tab completion for Bash, Zsh, and Fish

Installation#

Note

This package downloads and installs additional third-party open source software projects. Review the license terms of these open source projects before use.

Install in a Virtual Environment#

pip install nemo-microservices

Or with uv:

uv pip install nemo-microservices

Warning

When installed in a virtual environment, the nmp command is only available when the environment is activated.

Verify Installation#

nmp --help

If you see Unknown command: nmp, see the Troubleshooting page.

Getting Started#

1. Configure the CLI#

Run the interactive configuration wizard to set up your connection:

nmp configure

2. Verify Your Connection#

nmp workspaces list

This command outputs a list of available workspaces. If the connection fails, see Troubleshooting for common issues and solutions.

Command Structure#

The CLI follows a consistent pattern:

nmp [GLOBAL OPTIONS] <command> [<subcommand>...] [OPTIONS]

Global options apply to all commands:

Option

Description

--context, -c

Use a specific context (overrides current)

--base-url

Override the API base URL

--output-format, -f

Output format: table, json, yaml, csv, markdown

--verbose, -v

Enable verbose output for debugging

Commands are organized into categories:

Category

Commands

Description

API

models, jobs, workspaces, inference, …

Interact with NeMo Microservices APIs

Configuration

configure, config

Manage CLI configuration

Deployment

quickstart, cluster-info

Manage local quickstart

Use Cases

chat

Higher-level workflows

Common Workflows#

Exploring Commands#

Use --help on any command to see available options and subcommands:

# See all available commands
nmp --help

# See subcommands for a specific resource
nmp models --help

# See options for a specific command
nmp models list --help

Local Deployment with Quickstart#

# Start the quickstart environment
nmp quickstart up

# Check status
nmp quickstart status

# View logs
nmp quickstart logs

# Stop the environment
nmp quickstart down

Integrating with Other Tools#

The CLI outputs JSON with -f json, making it easy to integrate with tools like jq, shell scripts, and CI/CD pipelines.

Filtering with jq#

# Get just the model names
nmp models list -f json | jq -r '.data[].name'

# Find models matching a pattern
nmp models list -f json | jq -r '.data[] | select(.name | contains("nvidia"))'

CSV Export#

# Export to CSV for spreadsheets
nmp models list -f csv --all-pages --no-truncate --output-columns all > models.csv

Next Steps#