Yabai Scratchpad

A simple CLI tool that brings scratchpad functionality to the Yabai window manager on macOS. Inspired by LeftWM scratchpad, allows quick access and dismissal of any application.

Quick Start

Toggle a scratchpad window:

scratchpad --toggle {name}

Example SKHD binding:

alt - t : scratchpad --toggle telegram

Installation

# Step 1: Clone repository
git clone https://github.com/arpandaze/scratchpad-rs
cd scratchpad-rs

# Step 2: Build
cargo build --release

# Step 3: Install to path (use /opt/homebrew/bin/ for SKHD compatibility)
cp target/release/scratchpad /opt/homebrew/bin/

# Step 4: Create config directory and file
mkdir -p ~/.config/scratchpad
touch ~/.config/scratchpad/config.toml

# Step 5: Add SKHD bindings
# Example: echo 'alt - t : scratchpad --toggle telegram' >> ~/.skhdrc

Note: Copying binary to /usr/local/bin won’t work with SKHD.

Documentation

Documentação completa em docs/. Consulte docs/000-index.md para navegação detalhada.

By Topic

By Concept

By Keyword

Common Tasks

Install and Build from Source

→ docs/001-README.md (Steps 1-3: clone, build with cargo, copy binary)

Configure Scratchpads

→ docs/001-README.md (Config Options table and Configuration Example section)

Set Up SKHD Hotkeys

→ docs/001-README.md (Step 5 and Usage section)

Toggle Scratchpad Windows

→ docs/001-README.md (Usage section with scratchpad --toggle {name} command)

Configure App Launch Types

→ docs/001-README.md (launch_type options: app, app_with_arg, command)

Set Grid Positioning

→ docs/001-README.md (rows, cols, position, size configuration options)