> This page is for version v0.25.0.
> For other versions, use one of these documentation indexes:
> - Latest (default): https://docs.nvidia.com/nemo/guardrails/latest/llms.txt
> - v0.25.0: https://docs.nvidia.com/nemo/guardrails/v0.25.0/llms.txt
> - v0.24.1: https://docs.nvidia.com/nemo/guardrails/v0.24.1/llms.txt
> - v0.24.0: https://docs.nvidia.com/nemo/guardrails/v0.24.0/llms.txt
> - v0.23.0: https://docs.nvidia.com/nemo/guardrails/v0.23.0/llms.txt
> - v0.22.0: https://docs.nvidia.com/nemo/guardrails/v0.22.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/nemo/guardrails/llms.txt.

# nemoguardrails.cli

## Submodules

* **[`nemoguardrails.cli.chat`](/nemo/guardrails/v0.25.0/guardrails-python-sdk/nemoguardrails/cli/chat)**
* **[`nemoguardrails.cli.debugger`](/nemo/guardrails/v0.25.0/guardrails-python-sdk/nemoguardrails/cli/debugger)**
* **[`nemoguardrails.cli.migration`](/nemo/guardrails/v0.25.0/guardrails-python-sdk/nemoguardrails/cli/migration)**
* **[`nemoguardrails.cli.providers`](/nemo/guardrails/v0.25.0/guardrails-python-sdk/nemoguardrails/cli/providers)**

## Package Contents

### Classes

| Name                                                   | Description |
| ------------------------------------------------------ | ----------- |
| [`ColangVersions`](#nemoguardrails-cli-ColangVersions) | -           |

### Functions

| Name                                                                         | Description                                                                                               |
| ---------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
| [`_forward_metrics_options`](#nemoguardrails-cli-_forward_metrics_options)   | Set the `NEMO_GUARDRAILS_SERVER_METRICS_*` variable of each metrics flag given, leaving the others alone. |
| [`_validation_error_summary`](#nemoguardrails-cli-_validation_error_summary) | Each failing field and why, without the input values, which can hold a model's credentials.               |
| [`action_server`](#nemoguardrails-cli-action_server)                         | Start a NeMo Guardrails actions server.                                                                   |
| [`cli`](#nemoguardrails-cli-cli)                                             | -                                                                                                         |
| [`convert`](#nemoguardrails-cli-convert)                                     | Convert Colang files and configs from older version to the latest.                                        |
| [`find_providers`](#nemoguardrails-cli-find_providers)                       | List and select LLM providers interactively.                                                              |
| [`hooks_server`](#nemoguardrails-cli-hooks_server)                           | Start a NeMo Guardrails hooks server, which checks agents' tool calls before they run.                    |
| [`server`](#nemoguardrails-cli-server)                                       | Start a NeMo Guardrails server.                                                                           |
| [`version_callback`](#nemoguardrails-cli-version_callback)                   | -                                                                                                         |

### Data

[`_COLANG_VERSIONS`](#nemoguardrails-cli-_COLANG_VERSIONS)

[`_HOOKS_SERVER_INFO_LOGGERS`](#nemoguardrails-cli-_HOOKS_SERVER_INFO_LOGGERS)

[`_METRICS_EXPORTER_HELP`](#nemoguardrails-cli-_METRICS_EXPORTER_HELP)

[`app`](#nemoguardrails-cli-app)

### API

```python
class nemoguardrails.cli.ColangVersions
```

**Bases:** `enum.Enum`

**`one`** `= '1.0'`

---

**`two_alpha`** `= '2.0-alpha'`

---

```python
nemoguardrails.cli._forward_metrics_options(
    exporter: typing.Optional[str],
    host: typing.Optional[str],
    port: typing.Optional[int]
) -> None
```

Set the `NEMO_GUARDRAILS_SERVER_METRICS_*` variable of each metrics flag given, leaving the others alone.

```python
nemoguardrails.cli._validation_error_summary(
    error: pydantic.ValidationError
) -> str
```

Each failing field and why, without the input values, which can hold a model's credentials.

```python
nemoguardrails.cli.action_server(
    port: int = typer.Option(default=8001, ...
)
```

Start a NeMo Guardrails actions server.

```python
nemoguardrails.cli.cli(
    _: typing.Optional[bool] = typer.Option(None, '-v', '-...
)
```

```python
nemoguardrails.cli.convert(
    path: str = typer.Argument(..., help='T...,
    from_version: nemoguardrails.cli.ColangVersions = typer.Option(default=(Colan...,
    verbose: bool = typer.Option(default=False,...,
    validate: bool = typer.Option(default=False,...,
    use_active_decorator: bool = typer.Option(default=True, ...,
    include_main_flow: bool = typer.Option(default=True, ...
)
```

Convert Colang files and configs from older version to the latest.

```python
nemoguardrails.cli.find_providers(
    list_only: bool = typer.Option(False, '--list...
)
```

List and select LLM providers interactively.

This command provides an interactive interface to explore and select LLM providers.
It supports both text completion and chat completion model providers.

When run without options:

1. First, you'll be prompted to select a provider type:

* Type to filter between "text completion" and "chat completion"
* Use arrow keys to navigate through matches
* Press Tab to autocomplete
* Press Enter to select

2. Then, you'll be prompted to select a specific provider:

* Type to filter through available providers
* Use arrow keys to navigate through matches
* Press Tab to autocomplete
* Press Enter to select

When run with --list:

* Simply lists all available providers
* No selection is made

```python
nemoguardrails.cli.hooks_server(
    config: typing.List[pathlib.Path] = typer.Option(..., exists=Tr...,
    host: str = typer.Option(default='127.0...,
    port: int = typer.Option(default=8100, ...,
    metrics_exporter: typing.Optional[str] = typer.Option(default=None, ...,
    metrics_host: typing.Optional[str] = typer.Option(default=None, ...,
    metrics_port: typing.Optional[int] = typer.Option(default=None, ...
)
```

Start a NeMo Guardrails hooks server, which checks agents' tool calls before they run.

```python
nemoguardrails.cli.server(
    port: int = typer.Option(default=8000, ...,
    config: typing.List[str] = typer.Option(default=[], ex...,
    default_config_id: typing.Optional[str] = typer.Option(default=None, ...,
    verbose: bool = typer.Option(default=False,...,
    disable_chat_ui: bool = typer.Option(default=False,...,
    auto_reload: bool = typer.Option(default=False,...,
    prefix: str = typer.Option(default='', he...,
    metrics_exporter: typing.Optional[str] = typer.Option(default=None, ...,
    metrics_host: typing.Optional[str] = typer.Option(default=None, ...,
    metrics_port: typing.Optional[int] = typer.Option(default=None, ...
)
```

Start a NeMo Guardrails server.

```python
nemoguardrails.cli.version_callback(
    value: bool
)
```

```python
nemoguardrails.cli._COLANG_VERSIONS = [(version.value) for version in ColangVersions]
```

```python
nemoguardrails.cli._HOOKS_SERVER_INFO_LOGGERS = ('nemoguardrails.server', 'nemoguardrails.guardrails')
```

```python
nemoguardrails.cli._METRICS_EXPORTER_HELP = "Expose the IORails non-streaming admission-queue metrics (guardrails.nonstream....
```

```python
nemoguardrails.cli.app = typer.Typer()
```