> This page is for NVIDIA Cluster Readiness Engine, version v0.5.0.
> For other versions, use one of these documentation indexes:
> - Latest · v0.7.0 (default): https://docs.nvidia.com/cluster-readiness-engine/v0.7.0/llms.txt
> - v0.6.0: https://docs.nvidia.com/cluster-readiness-engine/v0.6.0/llms.txt
> - v0.5.0: https://docs.nvidia.com/cluster-readiness-engine/v0.5.0/llms.txt

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.nvidia.com/cluster-readiness-engine/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.nvidia.com/cluster-readiness-engine/_mcp/server.

# nvcrectl Overview

> The nvcrectl CLI manages the full lifecycle of cluster certification and WorkloadRun.

`nvcrectl` is the command-line interface for the NVIDIA Cluster Readiness Engine. It handles installation, certification lifecycle, workload execution, and reporting — without requiring direct `kubectl` access for most operations.

## Install

```bash
curl -fsSL https://github.com/NVIDIA/cluster-readiness-engine/releases/latest/download/installer | bash
nvcrectl --version
```

To pin a version: `curl -fsSL https://github.com/NVIDIA/cluster-readiness-engine/releases/download/<tag>/installer | bash -s -- -v <tag>`.

The installer also creates a `kubectl-nvcre` symlink so the CLI is available as a kubectl plugin (`kubectl nvcre ...`).

## Command groups

| Command group | Purpose |
|--------------|---------|
| `nvcrectl setup` | Install and uninstall the controller and its dependencies |
| `nvcrectl certification` | Run, render, report, and list-categories for Certification resources |
| `nvcrectl workloadrun` | Run, render, report, status, and cancel WorkloadRun resources |
| `nvcrectl cluster` | Inspect GPU nodes, platform, and network topology |
| `nvcrectl workflow` | Render Workflow manifests offline with overrides applied |

## Global flags

These flags are available on subcommands that connect to a cluster:

| Flag | Description |
|------|-------------|
| `--kubeconfig` | Path to kubeconfig (defaults to `~/.kube/config`) |
| `--context` | Kubernetes context to use |
| `--namespace` / `-n` | Namespace override (not available on all subcommands) |

## Shell completion

```bash
nvcrectl completion bash >> ~/.bashrc
nvcrectl completion zsh >> ~/.zshrc
```