Flameshot

<div align="center"> <p> <h1> <a href="https://github.com/flameshot-org/flameshot"> <img src="data/img/app/org.flameshot.Flameshot.svg" alt="Flameshot" /> </a> <br /> Flameshot </h1> <h4>Powerful yet simple to use screenshot software.</h4> </p> <p> <a href="https://github.com/flameshot-org/flameshot/actions?query=workflow%3APackaging%28Linux%29"> <img src="https://img.shields.io/github/actions/workflow/status/flameshot-org/flameshot/Linux-pack.yml?branch=master&label=gnu%2Flinux" alt="GNU/Linux Build Status" /> </a> <a href="https://github.com/flameshot-org/flameshot/actions?query=workflow%3APackaging%28Windows%29"> <img src="https://img.shields.io/github/actions/workflow/status/flameshot-org/flameshot/Windows-pack.yml?branch=master&label=windows" alt="Windows Build Status" /> </a> <a href="https://github.com/flameshot-org/flameshot/actions?query=workflow%3APackaging%28MacOS%29"> <img src="https://img.shields.io/github/actions/workflow/status/flameshot-org/flameshot/MacOS-pack.yml?branch=master&label=macos" alt="MacOS Build Status" /> </a> <a href="https://flameshot.org/docs/installation/development-build/"> <img src="https://img.shields.io/badge/nightly%20builds-available-%23AA00FF" alt="Nightly Build" /> </a> <a href="https://github.com/flameshot-org/flameshot/releases"> <img src="https://img.shields.io/github/release/flameshot-org/flameshot.svg" alt="Latest Stable Release" /> </a> <a href="https://github.com/flameshot-org/flameshot/releases"> <img src="https://img.shields.io/github/downloads/flameshot-org/flameshot/total.svg" alt="Total Downloads" /> </a> <a href="https://github.com/flameshot-org/flameshot/blob/master/LICENSE"> <img src="https://img.shields.io/github/license/flameshot-org/flameshot.svg" alt="License" /> </a> <a href="https://hosted.weblate.org/engage/flameshot/"> <img src="https://hosted.weblate.org/widgets/flameshot/-/flameshot/svg-badge.svg" alt="Translation status" /> </a> <a href="https://flameshot.org"> <img src="https://img.shields.io/github/release/flameshot-org/flameshot.svg?label=docs" alt="Docs" /> </a> <br> <a href="https://snapcraft.io/flameshot"> <img alt="Get it from the Snap Store" src="https://snapcraft.io/static/images/badges/en/snap-store-black.svg" /> </a> <a href="https://flathub.org/apps/details/org.flameshot.Flameshot"> <img height="60" alt="Get it on Flathub" src="https://flathub.org/api/badge?locale=en"/> </a> </p> </div>

Preview

Index

• Features
• Usage
  • CLI configuration
  • Config file
• Keyboard Shortcuts
  • Local
  • Global
    • On KDE Plasma desktop
    • On Gnome (Ubuntu, Fedora and more)
    • On XFCE 4
    • On Fluxbox
• Considerations
• Installation
  • Prebuilt Packages
  • Packages from Repository
  • MacOS
  • Windows
• Compilation
  • Dependencies
    • Compile-time
    • Run-time
    • Optional
    • Debian
    • Fedora
    • Arch
  • Build
  • Install
• License
• Privacy Policy
• Code Signing Policy
• Contribute
• Acknowledgment

Features

• Customizable appearance.
• Easy to use.
• In-app screenshot editing.
• DBus interface.
• Upload to Imgur.

Usage

Executing the command flameshot without parameters will launch a running instance of the program in the background without taking actions. If your desktop environment provides tray area, a tray icon will also appear in the tray for users to perform configuration and management.

Example commands:

• Capture with GUI:

  flameshot gui
  

• Capture with GUI with custom save path:

  flameshot gui -p ~/myStuff/captures
  

• Capture with GUI after 2 seconds delay (can be useful to take screenshots of mouse hover tooltips, etc.):

  flameshot gui -d 2000
  

• Fullscreen capture with custom save path (no GUI) and delayed:

  flameshot full -p ~/myStuff/captures -d 5000
  

• Fullscreen capture with custom save path copying to clipboard:

  flameshot full -c -p ~/myStuff/captures
  

• Capture the screen containing the mouse and print the image (bytes) in PNG format:

  flameshot screen -r
  

• Capture the screen number 1 and copy it to the clipboard:

  flameshot screen -n 1 -c
  

In case of doubt choose the first or the second command as shortcut in your favorite desktop environment.

A systray icon will be in your system's panel while Flameshot is running. Do a right click on the tray icon and you'll see some menu items to open the configuration window and the information window. Check out the About window to see all available shortcuts in the graphical capture mode.

Usage on Windows

On Windows, flameshot.exe will behave as expected for all supported command-line arguments, but it will not output any text to the console. This is problematic if, for example, you are running flameshot.exe -h.

If you require console output, run flameshot-cli.exe instead. flameshot-cli.exe is a minimal wrapper around flameshot.exe that ensures all stdout is captured and output to the console.

CLI configuration

You can use the graphical menu to configure Flameshot, but alternatively you can use your terminal or scripts to do so.

• Open the configuration menu:

  flameshot config
  

• Show the initial help message in the capture mode:

  flameshot config --showhelp true
  

• For more information about the available options use the help flag:

  flameshot config -h
  

Config file

You can also edit some of the settings (like overriding the default colors) in the configuration file.
Linux path: ~/.config/flameshot/flameshot.ini.
Windows path: C:\Users\{YOURNAME}\AppData\Roaming\flameshot\flameshot.ini.

When copying over the config file from Linux to Windows or vice versa, make sure to correct the savePath variable,
so that the screenshots save in the right directory on your desired file system.

Keyboard shortcuts

Local

These shortcuts are available in GUI mode:

| Keys | Description | |--- |--- | | <kbd>P</kbd> | Set the Pencil as paint tool | | <kbd>D</kbd> | Set the Line as paint tool | | <kbd>A</kbd> | Set the Arrow as paint tool | | <kbd>S</kbd> | Set Selection as paint tool | | <kbd>R</kbd> | Set the Rectangle as paint tool | | <kbd>C</kbd> | Set the Circle as paint tool | | <kbd>M</kbd> | Set the Marker as paint tool | | <kbd>T</kbd> | Add text to your capture | | <kbd>B</kbd> | Set Pixelate as the paint tool | | <kbd>←</kbd>, <kbd>↓</kbd>, <kbd>↑</kbd>, <kbd>→</kbd> | Move selection 1px | | <kbd>Shift</kbd> + <kbd>←</kbd>, <kbd>↓</kbd>, <kbd>↑</kbd>, <kbd>→</kbd> | Resize selection 1px | | <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>←</kbd>, <kbd>↓</kbd>, <kbd>↑</kbd>, <kbd>→</kbd> | Symmetrically resize selection 2px | | <kbd>Esc</kbd> | Quit capture | | <kbd>Ctrl</kbd> + <kbd>M</kbd> | Move the selection area | | <kbd>Ctrl</kbd> + <kbd>C</kbd> | Copy to clipboard | | <kbd>Ctrl</kbd> + <kbd>S</kbd> | Save selection as a file | | <kbd>Ctrl</kbd> + <kbd>Z</kbd> | Undo the last modification | | <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>Z</kbd> | Redo the next modification | | <kbd>Ctrl</kbd> + <kbd>Q</kbd> | Leave the capture screen | | <kbd>Ctrl</kbd> + <kbd>O</kbd> | Choose an app to open the capture | | <kbd>Ctrl</kbd> + <kbd>Return</kbd> | Commit text in text area| | <kbd>Ctrl</kbd> + <kbd>Backspace</kbd> | Cancel current selection | | <kbd>Return</kbd> | Upload the selection to Imgur | | <kbd>Spacebar</kbd>