LinuxCommandLibrary

hyprshot

Capture screenshots for Hyprland

TLDR

Select and take a screenshot of a region

$ hyprshot [[-m|--mode]] region
copy

Select and take a screenshot of a specific window
$ hyprshot [[-m|--mode]] window
copy

Select and take a screenshot of a specific output
$ hyprshot [[-m|--mode]] output
copy

Take a screenshot of the currently active window
$ hyprshot [[-m|--mode]] active [[-m|--mode]] window
copy

Freeze the screen and take a screenshot of the selected region
$ hyprshot [[-z|--freeze]] [[-m|--mode]] region
copy

Select and take a screenshot of a specific window, saving to the given output directory
$ hyprshot [[-o|--output-folder]] [path/to/directory] [[-m|--mode]] window
copy

Select and take a screenshot of a specific output, saving the screenshot to the clipboard only
$ hyprshot --clipboard [[-m|--mode]] output
copy

SYNOPSIS

hyprshot [OPTIONS]
hyprshot -m {region|output|window} [-o {file|clipboard|upload}] []

PARAMETERS

-m, --mode MODE
    Specifies the capture mode: region for interactive selection, output for the current monitor, or window for a specific application window.

-o, --output TYPE
    Determines the destination for the screenshot: file to save to disk, clipboard to copy to the clipboard, or upload to upload to Imgur.

-s, --silent
    Disables desktop notifications after taking a screenshot.

-c, --clipboard
    A shorthand option to copy the captured screenshot to the clipboard. Equivalent to --output clipboard.

-f, --file PATH
    A shorthand option to save the captured screenshot to a specified file path. Equivalent to --output file PATH.

-u, --upload
    A shorthand option to upload the captured screenshot to Imgur. Equivalent to --output upload.

-d, --delay SECONDS
    Introduces a delay in seconds before taking the screenshot.

-e, --edit
    Opens the screenshot in swappy for editing after capture.

-z, --freeze
    Freezes the screen during interactive region or window selection, preventing visual updates.

-r, --raw
    Prints the raw image data of the screenshot to standard output.

-p, --print
    Prints the full path of the saved file to standard output when using --output file.

-w, --wait
    Waits for the grim utility to finish its operations before proceeding.

-h, --help
    Displays the help message and exits.

-v, --version
    Prints the version information and exits.

DESCRIPTION

hyprshot is a modern and feature-rich screenshot utility specifically designed for the Wayland compositor Hyprland. It provides a seamless experience for capturing screenshots with various modes, including interactive region selection, full window capture, or entire output (monitor) capture.

Users can choose to copy the captured image directly to the clipboard, save it to a specified file path, or even upload it to Imgur for easy sharing. The tool integrates well with other Wayland utilities like slurp for selection and wl-clipboard for clipboard operations. It also supports post-capture editing with swappy and provides customizable desktop notifications for feedback. hyprshot aims to be a fast, intuitive, and highly configurable solution for all screenshot needs within the Hyprland environment.

CAVEATS

hyprshot is designed for the Hyprland Wayland compositor and relies heavily on Wayland-specific utilities. It may not function correctly on X11 environments or other Wayland compositors that do not provide the necessary protocols or helper applications. The tool requires several external dependencies such as grim for image capture, slurp for interactive selection, wl-clipboard for clipboard operations, and swappy for image editing. Users planning to utilize the Imgur upload feature must ensure they have properly configured Imgur authentication or provided a client ID.

HISTORY

hyprshot emerged as a dedicated screenshot solution for the growing Hyprland Wayland compositor community. With Wayland's security model, traditional X11 screenshot tools often don't work, necessitating native Wayland alternatives. hyprshot fills this gap by leveraging Wayland-native tools like grim and slurp. Its development focuses on providing a feature-rich yet simple-to-use utility, quickly becoming a popular choice for Hyprland users due to its interactive capabilities and various output options. It's an active open-source project, continuously evolving with community contributions.

SEE ALSO

grim(1), slurp(1), wl-clipboard(1), swappy(1)

Copied to clipboard