> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.nvidia.com/nemo-helix/v0.8.0/documentation/reference/cli-reference/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.nvidia.com/nemo-helix/_mcp/server. # NeMo Helix CLI The NeMo Helix CLI (`nemo`) is a command-line tool for interacting with NeMo Helix. It provides a unified interface for managing models, running jobs, deploying inference endpoints, and working with a local setup. ## Key Capabilities * **API Operations** - Manage models, jobs, workspaces, and other resources * **Local Setup** - Configure local services, providers, and SDK context 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. If you previously installed the `nemo-microservices` package, uninstall it first to avoid conflicts: ```bash pip uninstall nemo-microservices ``` ### Install Install the PyPI `nemo-helix` wrapper package. From a source checkout, run `make bootstrap` from the repository root instead; the wrapper extras are defined by `packages/nemo_helix/pyproject.toml`. #### uv tool (recommended) One command, `nemo` available everywhere, nothing to activate. ```bash uv tool install "nemo-helix[all]" uv tool update-shell # Then restart the shell ``` #### Virtual environment Use when you also import the SDK from your own code. `nemo` works only while the environment is active. ```bash uv venv source .venv/bin/activate uv pip install "nemo-helix[all]" ``` Plain `pip install "nemo-helix[all]"` works in an environment you manage yourself. ### Verify Installation ```bash nemo --help ``` If you see `Unknown command: nemo`, see the [troubleshooting](/documentation/reference/cli-reference/troubleshooting) page. ## Getting Started ### 1. Configure the CLI Set up your connection: ```bash nemo config set --base-url https://nhx.example.com nemo auth login ``` ### 2. Verify Your Connection ```bash nemo workspaces list ``` This command outputs a list of available workspaces. If the connection fails, see [troubleshooting](/documentation/reference/cli-reference/troubleshooting) for common issues and solutions. ## Command Structure The CLI follows a consistent pattern: ``` nemo [GLOBAL OPTIONS] [...] [OPTIONS] ``` **Global options** apply to all commands: | Option | Description | | ---------------------------------------- | ---------------------------------------------------------------------------------------------------------- | | `--context, -c` | The name of the context to use. Overrides the current context in the config file. | | `--base-url` | Base URL for the NeMo Helix API | | `--output-format, --output, -f ` | Output format for how results are printed. \[possible values: table, json, yaml, markdown, csv, raw, code] | | `--no-truncate` | Don't truncate long values in table/markdown/csv output | | `--timestamp-format ` | Timestamp format for table/markdown/csv output \[possible values: relative, iso8601] | | `--verbose, -v` | Enable verbose messaging. This only impacts logs that are visible, it doesn't change any data outputs. | | `--no-telemetry` | Disable anonymous usage telemetry for this invocation. | **Commands** are organized into categories: | Category | Commands | Description | | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------- | | Setup | `setup`, `auth`, `config`, `services`, `skills` | Set up and run local platform components | | CLI functions | `chat`, `docs`, `describe`, `wait`, `plugins` | Interactive, documentation, and agent-oriented workflows | | Core plugins | `files`, `inference`, `jobs`, `models`, `secrets`, `workspaces` | Core platform resources | | Functional plugins | `agents`, `data-designer`, `guardrail`, `garak`, `anonymizer`, `evals`, `customization`, `insights`, `safe-synthesizer`, `experiments`, `intake` | Functional service and plugin commands | ## Common Workflows ### Exploring Commands Use `--help` on any command to see available options and subcommands: ```bash # See all available commands nemo --help # See subcommands for a specific resource nemo models --help # See options for a specific command nemo models list --help ``` ### Reading Documentation Use `nemo docs` to read bundled documentation from the CLI: ```bash nemo docs set-up/helm/install ``` ### Local Setup ```bash # Set up the platform (interactive wizard) nemo setup # Check if services are running curl -s http://localhost:8080/health/ready # View service logs cat ~/.local/state/nhx/instances//services.log # Stop services pkill -f "nemo services run" ``` ## 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 ```bash # Get just the model names nemo models list -f json | jq -r '.data[].name' # Find models matching a pattern nemo models list -f json | jq -r '.data[] | select(.name | contains("nvidia"))' ``` ### CSV Export ```bash # Export to CSV for spreadsheets nemo models list -f csv --all-pages --no-truncate --output-columns all > models.csv ``` ## Next Steps * [configuration](/documentation/reference/cli-reference/configuration) - Contexts, authentication, environment variables, and shell completion * [working-with-resources](/documentation/reference/cli-reference/working-with-resources) - Output formats, pagination, and input methods * [troubleshooting](/documentation/reference/cli-reference/troubleshooting) - Common issues and solutions * [reference](/documentation/reference/cli-reference/full-cli-reference) - Full command reference ## Docs - [Connect with CLI Contexts](https://docs.nvidia.com/nemo-helix/v0.8.0/documentation/reference/cli-reference/connect-to-deployments.md): Use CLI contexts to connect the NeMo CLI and Python SDK to local and remote NeMo Helix deployments. - [Configuration](https://docs.nvidia.com/nemo-helix/v0.8.0/documentation/reference/cli-reference/configuration.md): Reference for NeMo CLI configuration fields, precedence, telemetry, and shell completion. - [Working with Resources](https://docs.nvidia.com/nemo-helix/v0.8.0/documentation/reference/cli-reference/working-with-resources.md): - [Full CLI Reference](https://docs.nvidia.com/nemo-helix/v0.8.0/documentation/reference/cli-reference/full-cli-reference.md): - [Troubleshooting](https://docs.nvidia.com/nemo-helix/v0.8.0/documentation/reference/cli-reference/troubleshooting.md):