> ## Documentation Index
> Fetch the complete documentation index at: https://praison.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# NVIDIA NIM CLI

> Check your NVIDIA NIM provider setup from the terminal

`providers doctor` resolves the provider name the same way the Agent does and reports whether its API key is set.

```mermaid theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
graph LR
    C[doctor nim] --> R[Resolve alias]
    R --> P[nvidia-nim]
    P --> K{Key set?}
    K -->|Yes| OK[Ready]
    K -->|No| M[Missing key]

    classDef cmd fill:#6366F1,stroke:#7C90A0,color:#fff
    classDef proc fill:#189AB4,stroke:#7C90A0,color:#fff
    classDef ok fill:#10B981,stroke:#7C90A0,color:#fff
    classDef warn fill:#F59E0B,stroke:#7C90A0,color:#fff

    class C cmd
    class R,P,K proc
    class OK ok
    class M warn
```

## Quick Start

<Steps>
  <Step title="Set Your Key">
    ```bash theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
    export NVIDIA_API_KEY=nvapi-...
    ```
  </Step>

  <Step title="Run the Doctor">
    ```bash theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
    praisonai-ts providers doctor nvidia-nim
    praisonai-ts providers doctor nvidia-nim --json
    ```
  </Step>
</Steps>

## Aliases

```bash theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
praisonai-ts providers doctor nim
praisonai-ts providers doctor nvidia
```

## What the Doctor Reports

* The provider package and description.
* The environment variable it checks and whether it is set (masked preview).
* `ready` or `missing_key` status (`--json` returns the same fields).
* Supported modalities (chat, embeddings, image, audio, speech, tools).

<Note>
  The doctor checks a single key variable. For `NVIDIA_NIM_API_KEY`, `NVIDIA_NIM_API_BASE` and the full resolution order, see the [Code page](/docs/js/providers/nvidia-nim-code#environment-variables).
</Note>

## Related

<CardGroup cols={2}>
  <Card title="NVIDIA NIM Code Usage" icon="book" href="/docs/js/providers/nvidia-nim-code">
    Models, reasoning mode and local NIM
  </Card>

  <Card title="Providers CLI" icon="terminal" href="/docs/js/providers-cli">
    All provider CLI commands
  </Card>
</CardGroup>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.