Skip to content

grouzen/framework-tool-tui

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

38 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Framework System TUI

Rust ratatui Framework Laptop

A snappy TUI dashboard for controlling and monitoring your Framework Laptop hardware — charging, privacy, lighting, USB PD ports, and more.

demo

:octocat: Features

Framework Laptop Hardware

  • Live battery and charge status with limits and charging controls
  • Privacy toggles for microphone & camera
  • Input Deck Mode selector (Framework 16)
  • Keyboard & Fingerprint brightness controls
  • USB PD port monitoring
  • Fan RPM
  • Thermal info: CPU/GPU temperatures
  • System info: BIOS details

Installation

📀 Binaries

The pre-compiled binaries for Linux are available for download on the Releases page

📝 From source

Requires Rust (Edition 2024) and a Framework laptop.

git clone https://github.com/grouzen/framework-tool-tui.git
cd framework-tool-tui
cargo build --release
# or via cargo install
cargo install --path .

🐧 Linux distros

Gentoo linux

It is available via lamdness overlay

sudo eselect repository enable lamdness
sudo emaint -r lamdness sync
sudo emerge -av app-laptop/framework-tool-tui

Arch linux

It is available via AUR or archlinuxcn

[yay/paru] -S framework-tool-tui # Install from AUR
sudo pacman -S framework-tool-tui # Install from archlinuxcn

👨 Run

It needs to be running with root privileges to access hardware controls.

sudo framework-tool-tui

📝 Architecture

See ARCHITECTURE.md for full technical breakdown.

🤝 Contributing

Pull requests welcome! For bug reports or feature requests, see Issues.

Technical stack

🧑‍⚖️ License

MIT License

Copyright (c) 2025 Mykhailo Nedokushev

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

See LICENSE and Cargo.toml for license & dependencies.

About

TUI for controlling and monitoring Framework Computers hardware built in Rust

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages