Skip to content

README.md

Latest commit

 

History

History
109 lines (69 loc) · 2.59 KB

README.md

File metadata and controls

109 lines (69 loc) · 2.59 KB
Raw

wiggly

Prevent screen savers and lock screens by wiggling your mouse.

Install with curl:

curl -sSL https://raw.githubusercontent.com/nitodeco/wiggly/main/install.sh | bash

Install with PowerShell (Windows):

irm https://raw.githubusercontent.com/nitodeco/wiggly/main/install.ps1 | iex

Usage

wiggly [OPTIONS] [COMMAND]
Option Default Description
-r, --radius <VALUE> 75 Radius of the wiggle movement in pixels
-t, --timeout <DURATION> none Auto-exit after duration (e.g., 30s, 5m, 1h)
-v, -V, --version Print version information
Command Description
update Update wiggly to the latest version
uninstall Remove wiggly from your system

Press q to quit, or move your mouse manually to exit. When --timeout is set, wiggly auto-exits and shows a time remaining indicator.

Alternative Installation

With Cargo

cargo install --git https://github.com/nitodeco/wiggly.git

From Source

git clone https://github.com/nitodeco/wiggly.git
cd wiggly
cargo build --release

The binary will be at target/release/wiggly.

Platform Notes

macOS

Requires Accessibility permissions. On first run, grant permission in:

System Settings → Privacy & Security → Accessibility

Add your terminal app, then restart the terminal.

The installer opens a signed wiggly shortcut import automatically on macOS. Click Add Shortcut, then add your preferred keyboard shortcut from the shortcut details to start Wiggly from anywhere.

Linux

Requires libxdo for X11:

  • Ubuntu/Debian: sudo apt install libxdo-dev
  • Fedora: sudo dnf install libxdo-devel

Windows

No additional dependencies are required. If you see permission errors, try running your terminal as Administrator.

Development

Prerequisites

Setup

Install git hooks:

lefthook install
cog install-hook --all

Pre-commit Checks

The following checks run automatically on commit:

  • cargo fmt --check - Code formatting
  • cargo clippy -- -D warnings - Linting
  • cargo check - Compilation check
  • Conventional commit message validation

Contributing

Thank you for your interest in contributing! Please see CONTRIBUTING.md for details.

License

MIT License. See LICENSE for details.