Preview
Index
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.
Usage on Hyprland / Sway / wlroots
Please refer to this document for detailed instructions on how to set up Flameshot on Hyprland, Sway, and wlroots-based Wayland compositors.
Usage on minimal X11 window managers
On minimal X11 window managers (i3, dwm, xmonad, bspwm, ...), capturing may fail because no portal backend implements the Screenshot interface (errors such as "Could not locate the org.freedesktop.portal.Desktop service" or "Screenshot portal timed out"). Please refer to this document for the fix (enabling the legacy X11 capture).
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:
This is the beginning of the README. Read the rest at the original. Read the full README ↗
