> 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.
> For full documentation content, see https://docs.nvidia.com/nemo/guardrails/llms-full.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.nvidia.com/nemo/guardrails/_mcp/server.

# nemoguardrails.cli.debugger

## Module Contents

### Functions

| Name                                                                | Description                                                                                         |
| ------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
| [`flow`](#nemoguardrails-cli-debugger-flow)                         | Shows all details about a flow or flow instance.                                                    |
| [`flows`](#nemoguardrails-cli-debugger-flows)                       | Shows a table with all (active) flows ordered in terms of there interaction loop priority and name. |
| [`pause`](#nemoguardrails-cli-debugger-pause)                       | Pause current interaction.                                                                          |
| [`restart`](#nemoguardrails-cli-debugger-restart)                   | Restart the current Colang script.                                                                  |
| [`resume`](#nemoguardrails-cli-debugger-resume)                     | Pause current interaction.                                                                          |
| [`run_command`](#nemoguardrails-cli-debugger-run_command)           | -                                                                                                   |
| [`set_chat_state`](#nemoguardrails-cli-debugger-set_chat_state)     | Register the chat state that will be used by the debugger.                                          |
| [`set_output_state`](#nemoguardrails-cli-debugger-set_output_state) | Registers the state that will be used by the debugger.                                              |
| [`set_runtime`](#nemoguardrails-cli-debugger-set_runtime)           | Registers the runtime that will be used by the debugger.                                            |
| [`tree`](#nemoguardrails-cli-debugger-tree)                         | Lists the tree of all active flows.                                                                 |

### Data

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

[`chat_state`](#nemoguardrails-cli-debugger-chat_state)

[`runtime`](#nemoguardrails-cli-debugger-runtime)

[`state`](#nemoguardrails-cli-debugger-state)

### API

```python
nemoguardrails.cli.debugger.flow(
    flow_name: str = typer.Argument(help='Name o...
)
```

Shows all details about a flow or flow instance.

```python
nemoguardrails.cli.debugger.flows(
    all: bool = typer.Option(default=False,...,
    order_by_name: bool = typer.Option(default=False,...
)
```

Shows a table with all (active) flows ordered in terms of there interaction loop priority and name.

```python
nemoguardrails.cli.debugger.pause()
```

Pause current interaction.

```python
nemoguardrails.cli.debugger.restart()
```

Restart the current Colang script.

```python
nemoguardrails.cli.debugger.resume()
```

Pause current interaction.

```python
nemoguardrails.cli.debugger.run_command(
    command: str
)
```

```python
nemoguardrails.cli.debugger.set_chat_state(
    _chat_state: nemoguardrails.cli.chat.ChatState
)
```

Register the chat state that will be used by the debugger.

```python
nemoguardrails.cli.debugger.set_output_state(
    _state: nemoguardrails.colang.v2_x.runtime.flows.State
)
```

Registers the state that will be used by the debugger.

```python
nemoguardrails.cli.debugger.set_runtime(
    _runtime: nemoguardrails.colang.v2_x.runtime.runtime.RuntimeV2_x
)
```

Registers the runtime that will be used by the debugger.

```python
nemoguardrails.cli.debugger.tree(
    all: bool = typer.Option(default=False,...
)
```

Lists the tree of all active flows.

```python
nemoguardrails.cli.debugger.app = typer.Typer(name='!!!', no_args_is_help=True, add_completion=False)
```

```python
nemoguardrails.cli.debugger.chat_state: Optional[ChatState] = None
```

```python
nemoguardrails.cli.debugger.runtime: Optional[RuntimeV2_x] = None
```

```python
nemoguardrails.cli.debugger.state: Optional[State] = None
```