hypr-cycle 0.5.1

A fast and monitor-aware workspace cycler for Hyprland, written in Rust.
Documentation 
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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133

# hypr-cycle

<p align="center">
  <video src="https://github.com/user-attachments/assets/df5e5d89-56ec-418e-9d30-19ff901f6c6d" autoplay loop muted playsinline width="720"></video>
</p>

A fast, minimal Rust utility to cycle through workspaces on the **currently focused monitor** in [Hyprland](https://github.com/hyprwm/Hyprland). Unlike `hyprctl dispatch workspace e+1`, this tool avoids switching workspaces to a different monitor in multi-monitor setups. Unlike `hyprctl dispatch focusworkspaceoncurrentmonitor next`, this will only switch to workspaces with windows on them.

![Build](https://github.com/christopherdolan/hypr-cycle/actions/workflows/rust.yml/badge.svg)

---

## Features

- Cycles only the workspaces **bound to the focused monitor**
- Wraps around when reaching the end or beginning
- Fast, clean, and dependency-free
- Written in Rust for performance and reliability

---

## Installation

### Cargo

If you've got the [Rust tools](https://rust-lang.org/tools/install/) installed, this is probably the easiest way to get it.

```bash
  cargo install hypr-cycle
```

### Arch Linux (via the AUR)

- Requires [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git).

1. Clone the repo:

```bash
git clone https://aur.archlinux.org/hypr-cycle.git
```

2. Make and install

```bash
cd hypr-cycle
makepkg -si
```

... or just install `hypr-cycle` via your favorite AUR helper.
(This is the only method that doesn't require you to have Rust tools installed.)

- Example requires [yay](https://github.com/Jguer/yay?tab=readme-ov-file#installation), but any AUR helper will do.

  ```bash
  yay hypr-cycle
  ```

### From Source

- Requires [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git).
- Requires [Rust](https://rust-lang.org/tools/install/).

1. Clone the repo:

   ```bash
   git clone https://github.com/christopherdolan/hypr-cycle
   cd hypr-cycle
   ```

2. Build and install:

   ```bash
   cargo build --release
   sudo install -Dm755 target/release/hypr-cycle /usr/local/bin/hypr-cycle
   ```

**If you want to package this for other distributions, be my guest!**

---

## Usage

```bash
hypr-cycle previous
hypr-cycle next
```

This will cycle to the next or previous numbered workspace **on the monitor that currently has keyboard focus**.

---

## Example Hyprland Config

If you want to change workspaces using Mod+Tab and Mod+Shift+Tab, add these bindings to your `~/.config/hypr/hyprland.conf`:

```ini
bind = $mod SHIFT, Tab, exec, hypr-cycle previous
bind = $mod, Tab, exec, hypr-cycle next
```

---

## Example Waybar Config

If you want to change workspaces on Waybar using your mouse wheel, add these to your `~/.config/waybar/config.jsonc`:

```jsonc
        "hyprland/workspaces": {
            // ...
            "on-scroll-up":"hypr-cycle previous",
            "on-scroll-down":"hypr-cycle next",
            // ...
        },
```

---

## Dependencies

- [Hyprland](https://github.com/hyprwm/Hyprland)
- Rust (for building only)

---

## License

MIT license. See `LICENSE` file.

---

## Contributions

PRs and suggestions welcome! This is a minimal utility, but if you have an idea to make it more powerful or efficient, feel free to open an issue or PR.