---
title: Container CLI
description: Configure and manage your Nestri container environment using CLI parameters for relay settings, video resolution, GPU selection, and encoding options.
icon: 'lucide:terminal'
---

The Container CLI for Nestri provides parameters to configure and manage your container environment. Use these options to set values like `relay-url`, `video resolution`, and `frame rate`. Additionally, activate `verbose` mode and logging to assist in debugging and error tracking. This documentation details each parameter to help you optimize your container setup effectively

| **Parameter**            | **Type** | **Default** | **Description**                                                                   |
|--------------------------|----------|-------------|-----------------------------------------------------------------------------------|
| `-v, --verbose`          | `string` | false       | Enable verbose output. Set to `true` for detailed logs.                           |
| `-d, --debug`            | `string` | false       | Enable additional debugging features. Set to `true` for extra debug information.  |
| `-u, --relay-url`        | `string` |             | Nestri relay URL. Specify the URL for the Nestri relay server.                    |
| `-r, --resolution`       | `string` | 1280x720    | Display/stream resolution in 'WxH' format. Default is 1280x720.                   |
| `-f, --framerate`        | `string` | 60          | Display/stream framerate. Default is 60 FPS.                                      |
| `--room`                 | `string` |             | Nestri room name/identifier. Specify the room for your Nestri session.            |
| `-g, --gpu-vendor`       | `string` |             | GPU vendor to use (e.g., NVIDIA, AMD, Intel).                                     |
| `-n, --gpu-name`         | `string` |             | GPU name to use. Specify the exact GPU model.                                     |
| `-i, --gpu-index`        | `string` | -1          | GPU index to use. Default is -1 (auto-select).                                    |
| `--gpu-card-path`        | `string` |             | Force a specific GPU by `/dev/dri/` card or render path.                          |
| `-c, --video-codec`      | `string` | h264        | Preferred video codec. Options: h264, h265, av1. Default is h264.                 |
| `--video-encoder`        | `string` |             | Override video encoder (e.g., `nvenc`, `libx264`).                                |
| `--video-rate-control`   | `string` | cbr         | Rate control method. Options: cqp, vbr, cbr. Default is cbr.                      |
| `--video-cqp`            | `string` | 26          | Constant Quantization Parameter (CQP) quality. Default is 26.                     |
| `--video-bitrate`        | `string` | 6000        | Target bitrate in kbps. Default is 6000 kbps.                                     |
| `--video-bitrate-max`    | `string` | 8000        | Maximum bitrate in kbps. Default is 8000 kbps.                                    |
| `--video-encoder-type`   | `string` | hardware    | Encoder type. Options: software, hardware. Default is hardware.                   |
| `--audio-capture-method` | `string` | pulseaudio  | Audio capture method. Options: pulseaudio, pipewire, alsa. Default is pulseaudio. |
| `--audio-codec`          | `string` | opus        | Preferred audio codec. Default is opus.                                           |
| `--audio-encoder`        | `string` |             | Override audio encoder (e.g., `opusenc`).                                         |
| `--audio-rate-control`   | `string` | cbr         | Audio rate control method. Options: cqp, vbr, cbr. Default is cbr.                |
| `--audio-bitrate`        | `string` | 128         | Target audio bitrate in kbps. Default is 128 kbps.                                |
| `--audio-bitrate-max`    | `string` | 192         | Maximum audio bitrate in kbps. Default is 192 kbps.                               |
| `--dma-buf`              | `string` | false       | Use DMA-BUF for pipeline. Set to `true` to enable DMA-BUF support.                |
| `-h, --help`             |          |             | Print help information for the CLI parameters.                                    |