10 releases (6 breaking)

0.7.1 Mar 10, 2024
0.7.0 Sep 18, 2023
0.6.0 Jul 5, 2023
0.5.0 Mar 13, 2023
0.1.0 Aug 1, 2022

#201 in Unix APIs

Download history 272/week @ 2024-02-15 312/week @ 2024-02-22 195/week @ 2024-02-29 425/week @ 2024-03-07 269/week @ 2024-03-14 226/week @ 2024-03-21 192/week @ 2024-03-28 204/week @ 2024-04-04 276/week @ 2024-04-11 275/week @ 2024-04-18 204/week @ 2024-04-25 245/week @ 2024-05-02 202/week @ 2024-05-09 196/week @ 2024-05-16 252/week @ 2024-05-23 181/week @ 2024-05-30

856 downloads per month

MIT license

47KB
940 lines

blight

Generated using Dall-E 2 (Credits: Sneha Sundar, for generating this lovely image for blight using DALL·E 2)

Rust Crates.io Downloads License

"And man said, 'let there b-light' and there was light." - Some Book 1:3

Primarily, a hassle-free CLI utility to manage backlight on Linux; one that plays well with hybrid GPU configuration and proprietary drivers.

The parts which blight relies on to make backlight changes, are also exposed through the library aspect of this crate, which can be used like any other Rust library by using the command cargo add blight in your Rust project. The CLI utility, on the other hand, can be installed by running cargo install blight.

Note This page contains documentation for the CLI. For library docs, visit docs.rs.

Warning For this program to run without root privileges, the user needs to be in the video group and might need udev rules to allow write access to brightness files. Read more about it here. You can gain required permissions by using the helper script that comes with blight by running sudo blight setup once or you could do it manually too. If not, you'd have to run the program with sudo every time.

Screenshots

About

A lot of Linux backlight utilities often fail to detect the right backlight device to control in laptops that ship with Intel or Amd iGPUs and an Nvidia dGPU with proprietary drivers. This utility aims to solve that problem by prioritizing integrated graphic devices, followed by dedicated Nvdia GPU and ACPI kernel module. This means that you do not have to manually specify which device is currently active whenever you switch between your iGPU and dGPU using the MUX switch. Other than that, blight also implements the sweep functionality, which lets you change brightness in a smooth sweeping manner, rather than applying sudden jerky increments/decrements.

In principle, blight should work on any GNU/Linux distro, and even on systems without hybrid GPU configuration. However, it has only been tested on Arch and Debian so far. Any feedback and bug reports will be greatly appreciated.

Usage

Set custom shortcuts using your distro settings or pair it with a hotkey daemon like sxhkd and you'll be good to go. blight doesn't execute any code if another instance is already running, so do not worry about spamming the key that triggers it.

Commands

  • Display help blight (quick help) or blight help
  • Display status blight status OR blight status -d device_name
  • Run first time setup script (for write permissions) sudo blight setup
  • List all backlight devices blight list
  • Increase brightness blight inc 5 (increase by 5%)
  • Decrease brightness blight dec 10 (decrease by 10%)
  • Increase/decrease brightness smoothly blight inc 10 -s OR blight dec 10 --sweep
  • Set custom brightness value blight set 50
  • Increase brightness for specific device blight inc 2 -d nvidia_0
  • Save brightness blight save OR blight save -d amdgpu_bl0
  • Restore brightness blight restore

Install

Using Cargo

  • cargo install blight
  • Binary will be compiled to $HOME:.cargo/bin

Compile from Source

  • Clone repository
  • cd cloned-repo
  • cargo build -r

Contribute

Coding, for me, is a hobby and I'm very much new to Rust and to programming as a whole. So if you notice anything in the code that can be improved, do open an issue to voice your opinion and pass on your suggestions. If you want to improve the code directly, please raise a pull-request, I'd be happy to collaborate and work to improve this together. Cheers!

Dependencies

~2–13MB
~121K SLoC