Hyprscratch

Hyprscratch makes scratchpads in Hyprland painless in a well-integrated and flexible way. Supports workspace-local scratchpads, special workspaces, multiple active scratchpads, cycling, event listeners, and extensive configuration options.

Quick Start

# In hyprland.conf:

# Start the daemon
exec-once = hyprscratch init clean eager

# Bind scratchpads
bind = $mainMod, b, exec, hyprscratch btop "[size monitor_h*0.7 monitor_h*0.8] alacritty --title btop -e btop" persist pin
bind = $mainMod, f, exec, hyprscratch "Mozilla Firefox" firefox special monitor 1

Installation

# Cargo (Rust)
cargo install hyprscratch

# Arch Linux (AUR)
paru -S hyprscratch

# Nix (non-NixOS)
nix profile install github:sashetophizika/hyprscratch

Documentation

Documentacao completa em docs/. Consulte docs/000-index.md para navegacao detalhada.

By Topic

Topic	Files	Description
Installation	001	Nix Flakes, Home Manager setup
Configuration & Usage	002	Daemon options, scratchpad options, config file

By Keyword

Keyword	File
nix	docs/001-NIX.md
nix-flakes	docs/001-NIX.md
home-manager	docs/001-NIX.md
installation-guide	docs/001-NIX.md
hyprland	docs/002-README.md
scratchpad	docs/002-README.md
window-management	docs/002-README.md
wayland	docs/002-README.md
daemon-options	docs/002-README.md
scratchpad-options	docs/002-README.md
config-file	docs/002-README.md
keybinds	docs/002-README.md
special-workspace	docs/002-README.md
groups	docs/002-README.md

Learning Path

1. Foundation: Read docs/001-NIX.md for Nix-based installation
2. Core Understanding: Learn main features from docs/002-README.md
3. Practical Application: Configure scratchpads and daemon options

Common Tasks

Install via Nix/Home Manager

-> docs/001-NIX.md (Flake input, Home Manager module, nix profile)

Initialize the Daemon

-> docs/002-README.md (exec-once = hyprscratch init [options])

Configure Scratchpads in hyprland.conf

-> docs/002-README.md (bind syntax with title, command, options)

Use Dedicated Config File

-> docs/002-README.md (~/.config/hypr/hyprscratch.conf format)

Daemon Options (clean, spotless, eager)

-> docs/002-README.md (auto-hide behavior, eager spawn)

Scratchpad Options (persist, cover, sticky, special)

-> docs/002-README.md (extensive list of behavior modifiers)

Group Multiple Scratchpads

-> docs/002-README.md (group syntax in config file)

Extra Commands (cycle, previous, hide-all)

-> docs/002-README.md (subcommands for advanced control)