Hyprscratch

https://docs.rs/hyprscratch/0.6.4/
Admin
Hyprscratch is a tool for managing scratchpads in Hyprland with flexible configuration, event...
Tokens:1,277
Snippets:15
Trust Score:9.1
Update:6 months ago
Show doc for...
Tokens:
Raw
### Example scratchpad configuration

Source: https://docs.rs/crate/hyprscratch

Practical examples of initializing the daemon and binding specific applications to scratchpads.

```text
exec-once = hyprscratch init clean eager

bind = $mainMod, b, exec, hyprscratch btop "[size 70% 80%] alacritty --title btop -e btop" persist pin
bind = $mainMod, f, exec, hyprscratch "Mozilla Firefox" firefox special monitor 1
```

--------------------------------

### Install hyprscratch via AUR

Source: https://docs.rs/crate/hyprscratch

Install the package using the Arch User Repository.

```shell
paru -S hyprscratch
```

--------------------------------

### Install hyprscratch via Cargo

Source: https://docs.rs/crate/hyprscratch

Install the package using the Rust package manager.

```shell
cargo install hyprscratch
```

--------------------------------

### Configure hyprscratch in hyprland.conf

Source: https://docs.rs/crate/hyprscratch

Basic daemon initialization and scratchpad binding syntax for Hyprland configuration.

```text
# Start the hyprscratch daemon
exec-once = hyprscratch init [DAEMON_OPTIONS]

# Configure scratchpads
bind = $mainMod, $KEY, exec, hyprscratch $CLIENT_TITLE "$HYPRLAND_EXEC_COMMAND" [SCRATCHPAD_OPTIONS]
```

--------------------------------

### Bind configuration file scratchpads in hyprland.conf

Source: https://docs.rs/crate/hyprscratch

Commands to toggle, show, or hide scratchpads defined in an external configuration file.

```text
exec-once = hyprscratch init

bind = $mainMod, t, hyprscratch toggle scratchpad1
bind = $mainMod, s, hyprscratch show scratchpad1
bind = $mainMod, h, hyprscratch hide scratchpad1

bind = $mainMod, g, hyprscratch toggle group1
```

--------------------------------

### Define scratchpads in a configuration file

Source: https://docs.rs/crate/hyprscratch

Structure for defining scratchpads and groups in an external configuration file.

```text
# Optional globals that apply to all scratchpads
daemon_options = clean
global_options = special
global_rules = size 90% 90%

scratchpad1 {
    # Mandatory fields
    command = command

    # At least one is mandatory, title takes priority
    title = title
    class = class

    # Optional fields
    options = option1 option2 option3
    rules = rule1;rule2;rule3
}

# Groups that manage multiple scratchpads are also supported
group:group1 {
    # Add the already defined scratchpad to the group
    name = scratchpad1

    # Define a new scratchpad that can also be used independently
    scratchpad2 {
        title = title
        command = command
    }
}
```
Tokens:
Raw