netris-nestri/apps/docs/content/2.nestri-node/5.container-cli.md at 191c59d230a979b83637385101e6f611a83ff382

mirror of https://github.com/nestriness/nestri.git synced 2025-12-12 08:45:38 +02:00

Files

Philipp Neumann 191c59d230 📖 docs: Update README.md (#189 )

## Description
Update the readme file

## Related Issues
none

## Type of Change

- [ ] Bug fix (non-breaking change)
- [ ] New feature (non-breaking change)
- [ ] Breaking change (fix or feature that changes existing
functionality)
- [x] Documentation update
- [ ] Other (please describe):

## Checklist

- [x] I have updated relevant documentation
- [x] My code follows the project's coding style
- [x] My changes generate no new warnings/errors

## Notes for Reviewers
none

## Screenshots/Demo
none

## Additional Context
none

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- **Documentation**
- Major overhaul of documentation structure and content for improved
clarity, modern presentation, and ease of navigation.
- Updated and expanded guides for installation, setup, architecture, and
command-line interfaces.
- Enhanced FAQ and troubleshooting sections with more comprehensive
answers and technical details.
- Added new guides for self-hosting with reverse proxy examples (Caddy,
Traefik) and developer notes.
- Improved theming, styling, and home page layout for the documentation
site.
  - Simplified main README to a minimalistic project header and tagline.
- Added new documentation files for Nestri Relay introduction and
container CLI parameters.
- Removed outdated or redundant documentation files and components to
streamline content.

- **Chores**
- Updated, reorganized, or removed configuration files for dependencies,
linting, and environment setup.
- Switched to a new documentation theme and updated related project
dependencies.
- Removed Renovate configuration and ESLint config specific to docs app.
- Adjusted TypeScript and package configurations for better
compatibility.

- **Style**
- Improved dark mode support and visual consistency across documentation
and components.
- Introduced new Tailwind CSS theming and animation support for the
documentation site.

- **New Features**
- Added example configuration files for deploying Nestri Relay with
Caddy and Traefik reverse proxies.
- Introduced new Tailwind CSS theming and animation support for the
documentation site.
- Added a new logo component supporting light/dark mode and optional
title display.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Victor Pahuus Petersen <49293748+victorpahuus@users.noreply.github.com>
Co-authored-by: Wanjohi <elviswanjohi47@gmail.com>
Co-authored-by: DatCaptainHorse <DatCaptainHorse@users.noreply.github.com>

2025-07-01 05:34:53 +05:00

4.2 KiB

Raw Blame History

title, description, icon

title	description	icon
Container CLI	Configure and manage your Nestri container environment using CLI parameters for relay settings, video resolution, GPU selection, and encoding options.	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.

4.2 KiB Raw Blame History

4.2 KiB

Raw Blame History