aboutsummarylogtreecommitdiffstats
path: root/README.md
blob: 3b2557bf7361cc257f4f7447f0f4de98b68d02e3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
# hyprbole

terminal UI for managing the [Hyprland](https://hyprland.org) config.

includes options for keybinds, monitors, window rules, animations, and more.

![bash](https://img.shields.io/badge/bash-5%2B-orange) ![license](https://img.shields.io/badge/license-MIT-blue)

## what it does

writes to a separate `hyprbole-managed.conf` that gets sourced into your main `hyprland.conf`, so it never touches your hand-written config.

sections:
- keybinds
- monitors
- workspaces (special, named, persistent)
- window rules (windowrulev2)
- general, decoration, animations, input, misc
- autostart (exec-once / exec)
- env vars

all changes are backed up before writing.

## install

```bash
git clone https://github.com/vlensys/hyprbole
cd hyprbole
chmod +x hyprbole.sh
# optionally, add it to your PATH
sudo cp hyprbole.sh /usr/local/bin/hyprbole
```

or just drop it somewhere on your `$PATH`.

## usage

```
hyprbole           # launch
hyprbole --debug   # log all keypresses to /tmp/hyprbole-debug.log
hyprbole --fixes   # number of successful bug hunting sessions
```

**keys**
- `↑↓` / `j k` — navigate
- `enter` / `space` — select
- `n` — add new entry
- `d` — delete selected
- `q` / `ESC` — back
- `ctrl+q` — cancel current form

## requirements

- bash 5+
- tput (ncurses)
- runs inside a terminal, doesn't need Hyprland running (but `reload` does)

## how it works

on first run, hyprbole creates `~/.config/hypr/hyprbole-managed.conf` and appends a `source =` line to your `hyprland.conf`. all edits go into the managed file. backups live in `~/.config/hypr/hyprbole-backups/`.