45 lines
1.3 KiB
Markdown
45 lines
1.3 KiB
Markdown
<div align="center">
|
|
<img src="frontend/public/logo.svg" alt="NVCurve Logo" width="128" />
|
|
<h1>NVCurve</h1>
|
|
<p><strong>Linux NVIDIA GPU V/F Curve Editor & OC Tool</strong></p>
|
|
</div>
|
|
|
|
---
|
|
|
|
NVCurve brings MSI Afterburner-style per-point voltage-frequency curve control to Linux via undocumented NvAPI functions. A React web UI for interactive editing and monitoring; a Python CLI for scripting and headless use.
|
|
|
|
> [!WARNING]
|
|
> **Experimental software.** Undocumented NvAPI functions may change between driver releases. Write operations alter GPU operational parameters. Always run `nvcurve setup` before applying changes.
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
uv tool install nvcurve
|
|
```
|
|
|
|
## Getting Started
|
|
|
|
```bash
|
|
nvcurve setup # Verify hardware compatibility (do not skip)
|
|
nvcurve # Launch web UI at http://localhost:8042
|
|
```
|
|
|
|
## Documentation
|
|
|
|
- **[Overview](docs/Overview.md)** — What it does, capabilities, architecture
|
|
- **[Installation](docs/Installation.md)** — Prerequisites, source build, troubleshooting
|
|
- **[Usage Guide](docs/Usage-Guide.md)** — Web UI, CLI reference, systemd service
|
|
- **[Tips and Tricks](docs/Tips-and-Tricks.md)** — Workflows, curve flattening, safety
|
|
|
|
## Upgrading
|
|
|
|
```bash
|
|
uv tool upgrade nvcurve
|
|
```
|
|
|
|
## Changelog
|
|
|
|
See [CHANGELOG.md](CHANGELOG.md).
|