Skip to main content

Lightweight Wayland screenshot and annotation tool

Project description

WaySnip

Lightweight screenshot and annotation tool for Linux Wayland. Captures your screen, lets you select a region, annotate with shapes and text, and saves with a single shortcut. Built for documentation workflows and quick sharing.

Tested on Ubuntu 24.04 with GNOME Shell 46 on Wayland.

Features

  • Region, window, and fullscreen capture with frozen screen (menus don't close)
  • 11 annotation tools: rectangle, ellipse, arrow, line, text, numbered markers, freehand pen, highlight, blur/pixelate, crop
  • Color picker with recent colors, stroke width, opacity, font controls
  • Undo/redo, clone, multi-select, keyboard shortcuts for every tool
  • Re-editable annotations stored as PNG metadata
  • Gallery with thumbnail browser
  • System tray with hotkey support
  • Settings UI backed by TOML config
  • Auto-copy to clipboard on capture and save
  • Dark theme

Install

pipx install waysnip
waysnip setup

waysnip setup binds PrintScreen to region capture, Ctrl+PrintScreen to fullscreen, and enables tray autostart on login.

From source

git clone https://github.com/paalkr/waysnip.git
cd waysnip
python3 -m venv .venv && source .venv/bin/activate
pip install -e .
waysnip setup

Requirements

  • Linux with Wayland (GNOME recommended)
  • Python 3.12+
  • gnome-screenshot and wl-clipboard (pre-installed on Ubuntu 24.04)

Quick start

Action How
Region capture Press Print or waysnip region
Fullscreen capture Press Ctrl+Print or waysnip fullscreen
Window capture waysnip window
Open gallery waysnip gallery
Open settings waysnip config
Start tray only waysnip tray

Editor shortcuts

Key Action
V Select tool
R Rectangle
E Ellipse
A Arrow
L Line
T Text
N Numbered marker
P Freehand pen
H Highlight
B Blur/pixelate
C Crop
Ctrl+Z Undo
Ctrl+Y Redo
Ctrl+S Save
Ctrl+Shift+S Save as
Ctrl+C Copy to clipboard
Ctrl+D Clone selected
Del Delete selected

Configuration

Config file: ~/.config/waysnip/config.toml

[capture]
after_capture = "editor"    # "editor", "clipboard", "save", "clipboard+save"
auto_copy_clipboard = true
show_cursor = false

[save]
directory = "~/Pictures/Screenshots"
pattern = "Screenshot_%Y-%m-%d_%H-%M-%S.png"
mode = "annotated"          # "annotated" (re-editable) or "editable" (smaller)

[editor]
default_pen_color = "#ff0000"
default_pen_width = 3
default_blur_block_size = 10
copy_on_save = true

[tray]
enabled = true
left_click_action = "region"

Edit via GUI: waysnip config Edit directly: waysnip config --edit

Uninstall

waysnip uninstall
pipx uninstall waysnip

waysnip uninstall restores GNOME's default screenshot keys and removes the autostart entry.

License

GPL-3.0

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

waysnip-0.3.0.tar.gz (75.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

waysnip-0.3.0-py3-none-any.whl (81.8 kB view details)

Uploaded Python 3

File details

Details for the file waysnip-0.3.0.tar.gz.

File metadata

  • Download URL: waysnip-0.3.0.tar.gz
  • Upload date:
  • Size: 75.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for waysnip-0.3.0.tar.gz
Algorithm Hash digest
SHA256 ae5bea679da2c0a3c6c37ea44645ac576ab7acdd5e85cc65f04606626352e74c
MD5 f3684d794116d50a22e6ac5a6ce9f148
BLAKE2b-256 9ac9e0637cd998932bf366b35589ce953f2912af98b1331278010f70a352d89e

See more details on using hashes here.

Provenance

The following attestation bundles were made for waysnip-0.3.0.tar.gz:

Publisher: release.yml on paalkr/waysnip

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file waysnip-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: waysnip-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 81.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for waysnip-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 59fd6159a1844615c24bf61a2ce6e8ac60852aecc24018d3f0e39b9499ed4e5e
MD5 020604108678b540300c7f57e9709da6
BLAKE2b-256 9ae3e77894d559b8c5db38017c546fd64e61c6df92d71c3563f4801c24e653f0

See more details on using hashes here.

Provenance

The following attestation bundles were made for waysnip-0.3.0-py3-none-any.whl:

Publisher: release.yml on paalkr/waysnip

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page