ksnip

[![Linux build status][github-linux-badge]][github-linux-url] [![Windows build status][github-windows-badge]][github-windows-url] [![MacOS build status][github-macos-badge]][github-macos-url] [![GitHub commits (since latest release)][gh-comm-since-badge]][gh-comm-since-url]
[![Translation status][weblate-badge]][weblate-url] [![GitHub total downloads][gh-dl-badge]][gh-dl-url] [![SourceForge total downloads][sf-dt-badge]][sf-dt-badge-url] [![Discord][discord-badge]][discord-badge-url] [![IRC: #ksnip on libera.chat][libera-badge]][libera-badge-url]

Version v1.11.0

Ksnip is a Qt-based cross-platform screenshot tool that provides many annotation features for your screenshots.

ksnip

Features

Latest ksnip version contains following features:

Supports Linux (X11, Plasma Wayland, GNOME Wayland and xdg-desktop-portal Wayland), Windows and macOS.
Screenshot of a custom rectangular area that can be drawn with mouse cursor.
Screenshot of last selected rectangular area without selecting again.
Screenshot of the screen/monitor where the mouse cursor is currently located.
Screenshot of full-screen, including all screens/monitors.
Screenshot of window that currently has focus.
Screenshot of window under mouse cursor.
Screenshot with or without mouse cursor.
Capture mouse cursor as annotation item that can be moved and deleted.
Customizable capture delay for all capture options.
Upload screenshots directly to imgur.com in anonymous or user mode.
Upload screenshots via FTP in anonymous or user mode.
Upload screenshots via custom user defined scripts.
Command-line support, for capturing screenshots and saving to default location, filename and format.
Filename wildcards for Year ($Y), Month ($M), Day ($D), Time ($T) and Counter (multiple # characters for number with zero-leading padding).
Print screenshot or save it to PDF/PS.
Annotate screenshots with pen, marker, rectangles, ellipses, texts and other tools.
Annotate screenshots with stickers and add custom stickers.
Crop and cut out vertical/horizontal slices of images.
Obfuscate image regions with blur and pixelate.
Add effects to image (Drop Shadow, Grayscale, invert color or Border).
Add watermarks to captured images.
Global hotkeys for capturing screenshots (currently only for Windows and X11).
Tabs for screenshots and images.
Open existing images via dialog, drag-and-drop or paste from clipboard.
Run as single instance application (secondary instances send cli parameter to primary instance).
Pin screenshots in frameless windows that stay atop other windows.
User-defined actions for taking screenshot and post-processing.
OCR support through plugin (Window and Linux/Unix).
Many configuration options.

Supported Screenshot Types

| | Rect Area | Last Rect Area | Full Screen | Current Screen | Active Window | Window Under Cursor | Without Mouse Cursor | Screenshot Portal | | --------------------|:---------:|:--------------:|:-----------:|:--------------:|:-------------:|:-------------------:|:--------------------:|:-----------------:| | X11 | X | X | X | X | X | | X | | | Plasma Wayland | | | X | X | | X | | | | Gnome Wayland < 41| X | X | X | X | X | | X | | | xdg-desktop-portal* | | | | | | | | X | | Windows | X | X | X | X | X | | X | | | macOS | X | X | X | X | | | | |

* xdg-desktop-portal screenshots are screenshots taken by the compositor and passed to ksnip, you will see a popup dialog that requires additional confirmation, the implementation can vary depending on the compositor. Currently, Snaps and Gnome Wayland >= 41 only support xdg-desktop-portal screenshots, this is a limitation coming from the Gnome and Snaps, non-native screenshot tools are not allowed to take screenshots in any other way except through the xdg-desktop-portal.

Installing Binaries

Binaries can be downloaded from the Releases page. Currently, RPM, DEB, APT, Snap, Flatpak and AppImage for Linux, zipped EXE for Windows and APP for macOS in a DMG package are available.

Continuous build

All supported binaries are built for every pushed commit, to be found at the top of the release page. Continuous build artifacts are not fully tested and in most cases they are work in progress, so use them with caution.

Linux

Click on the item, to expand information.

<details> <summary>AppImage</summary>

To use AppImages, make them executable and run them, no installation is required.

$ chmod a+x ksnip*.AppImage
$ ./ksnip*.AppImage

More info about setting to executable can be found here.

</details> <details> <summary>RPM</summary>

Just install them via RPM and use.

$ rpm -Uvh ksnip*.rpm
$ ksnip

</details> <details> <summary>DEB</summary>

Just install them via apt and start using.

$ sudo apt install ./ksnip*.deb
$ ksnip

</details> <details> <summary>APT</summary>

Starting with Ubuntu 21.04 Hirsute Hippo, you can install from the official package:

$ sudo apt install ksnip

For older Ubuntu versions, you can use @nemonein's unofficial PPA:

sudo add-apt-repository ppa:nemonein/ksnip
sudo apt update
sudo apt install ksnip

For Debian 11 and later releases, you can install from the official package:

$ sudo apt install ksnip

For Debian 10 and Debian 9, ksnip is available via Debian Backports. Please enable bullseye-backports and buster-backports repo for Debian 10 and Debian 9 respectively before installing using sudo apt install ksnip.

</details> <details> <summary>ArchLinux</summary>

Ksnip is in the Extra repository, so you can install it directly via pacman.

$ sudo pacman -S ksnip

If you want to build from the GIT repository, you can use the AUR package (make sure you build the necessary dependencies too).

$ yay -S ksnip-git kimageannotator-git kcolorpicker-git

</details> <details> <summary>Snap</summary>

The usual method for Snaps, will install the latest version:

$ sudo snap install ksnip

The continuous build version is also available as edge, in order to install it you need to provide the edge flag:

$ sudo snap install ksnip --edge

Snap startup time can be sped up and console output cleaned up from following error Could not create AF_NETLINK socket (Permission denied) by running the following commands:

$ snap connect ksnip:network-observe
$ snap connect ksnip:network-manager-observe

If you need to save screenshots to a removable media, the following additional connection is required:

$ snap connect ksnip:removable-media

This only needs to be done once and connects some Snap plugs which are currently not auto-connected.

</Details> <details> <summary>Flatpak</summary>

The usual method for Flatpaks will install the latest version:

$ flatpak install flathub org.ksnip.ksnip

Then just start it:

$ flatpak run org.ksnip.ksnip

</details>

Windows

The MSI installer installs ksnip on your system and is the preferred way for installing ksnip under Windows.

</details> <details> <summary>EXE</summary>

The EXE file with all required dependencies comes in a zipped package, which just needs to be unzipped with your favorite unpacking tool. Ksnip can then be started by just double-clicking ksnip.exe.

</details>

macOS

The app file comes in a DMG package which needs to be opened, and the ksnip.app file needs to be dragged and dropped into the "Application" folder. After that the application can be started by double clicking ksnip.app

</details> <details> <summary>Homebrew Cask</summary>

Just install via Homebrew and start using from your "Applications" folder.

$ brew install --cask ksnip

</details>

Plugins

ksnip functionality can be extended by using plugins that need to be downloaded separately and installed or unpacked, depending on the environment. Currently, under Options > Settings > Plugins a plugin detection can be triggered either in the default location(s) or by providing a search path where to look for plugins. After clicking on "Detect", ksnip searches for known plugins and when found will list the name and version.

Default search locations

Windows: plugins directory, next to ksnip.exe
Linux/Unix: `/usr/local/li

Ksnip

Install / Use

README

ksnip

Features

Supported Screenshot Types

Installing Binaries

Continuous build

Linux

Windows

macOS

Plugins

Default search locations