> 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 Cluster Readiness Engine. It handles installation, certification lifecycle, workload execution, and reporting — without requiring direct `kubectl` access for most operations.

## Install

While this repository is internal, release assets require authenticated API
downloads, so fetch the installer with the gh CLI (`gh auth login` first):

```bash
export NVCRECTL_VERSION=v0.1.0-rc.9
gh release download "${NVCRECTL_VERSION}" --repo NVIDIA/cluster-readiness-engine \
  --pattern installer --output - | bash -s -- -v "${NVCRECTL_VERSION}"
nvcrectl --version
```

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
```