wayshot(1)

💅 wayshot(1) — the glow-up

okay bestie, so this is the manual page for wayshot, a screenshot tool for compositors that implement zwlr_screencopy_v1, like sway and river ✨ It's filed under General Commands Manual, and honestly it's giving main character energy.

---

🌸 SYNOPSIS 🌸

wayshot [options] [output]

---

🎀 ARGUMENTS 🎀

• output — where you want the captured screenshot to go, bestie. it can be one of these types:
  1. A directory — image outputs get saved in the default format wayshot-yyyy-mm-dd-hh-mm-ss.png 💖
  2. A path — encoding is automatically inferred from the extension, iykyk.
  3. - — which sends the screenshot to stdout. iconic.

also, the --clipboard option can be used at the same time as any of the above to copy the image to the clipboard too 🫶

---

✨ OPTIONS ✨

• -h — print concise help messages and quit. short and sweet.
• --help — print the full help message and quit. the whole lore dump.
• -V, --version — print version information 💅

🔍 Query (print info, then exit — no screenshot is taken)

• -l, --list-outputs — list all connected output names.
• --list-outputs-json — list all connected outputs with their name, description, size, and position, in JSON format.
• --list-outputs-info — list all connected outputs with their name, description, size, and position.
• --list-toplevels, --list-windows — list all active toplevel windows, with app_id, title and identifier.
• --list-toplevels-json — list all active toplevel windows, with app_id, title and identifier, in JSON format.
• --color — click a pixel and print its RGBA and hex color value. by default the screen is frozen first; use --no-freeze to pick on the live display 🎨

Requires the color_picker feature (enabled by default).

🦋 Capture target (what to capture)

• -g, --geometry [GEOMETRY] — select a screen region to capture.
  • Without a value: interactively select a region. by default the screen is frozen before the selection overlay is shown, giving a stable view for precise selection. use --no-freeze to select on the live display and capture after selection. Requires the selector feature.
  • With a value: capture the fixed region described by GEOMETRY, a string in slurp/grim format "x,y width_x_height" (e.g. "100,200 300x400"). Compatible with the output of slurp(1). Example: wayshot -g "$(slurp)"

Note: passing a file path directly after -g is no longer supported; place the path before the flag or use -- to separate arguments (e.g. wayshot -g -- file.png). lowkey a glow-up, highkey a breaking change 😭

• --geometry-background-color <RGBA_HEX_COLOR> — background color (rgba hex) while selecting a region (--geometry). Example: #00000050
• --geometry-foreground-color <RGBA_HEX_COLOR> — foreground color (rgba hex) while selecting a region (--geometry). Example: #ffffffff
• -o, --output <OUTPUT> — capture a specific output/display by name. use --list-outputs to discover names 💖
• --choose-output — present a fuzzy selector for output/display selection. so cozy.
• --toplevel <Identifier>, --window <Identifier> — capture a specific toplevel window identified by its identifier string. use --list-toplevels to discover available strings.
• --choose-toplevel, --choose-window — present a fuzzy selector for toplevel/window selection.

🔥 Capture options (how to capture)

• -c, --cursor — include the cursor in the screenshot. the little guy deserves to be seen 💀
• --no-freeze — do not freeze the screen when selecting a region (--geometry) or a point (--color). selection is done on the live display; the capture is taken after selection. Config: [base] freeze (see wayshot(5)).
• --delay MS — wait MS milliseconds before taking the screenshot. no delay when omitted. Config: [base] delay (see wayshot(5)).

🌈 Output options (where/how to save the image)

• -e, --encoding, --extension, --format, --file-format <FILE_EXTENSION> — set the image encoder. without this option, encoding is either inferred from the output filename or defaults to png. valid arguments:
  • jpg
  • png (default)
  • ppm
  • qoi
  • webp
  • avif (requires avif feature, enabled by default)
  • jxl (requires jxl feature, enabled by default)
• --file-name-format <FORMAT> — format string for the output file name. refer to chrono strftime formatting rules: https://docs.rs/chrono/latest/chrono/format/strftime/index.html

Example: --file-name-format "%Y_%m_%d-%H_%M_%S"

Default: wayshot-%Y_%m_%d-%H_%M_%S

• --clipboard — copy the screenshot to the Wayland clipboard. wayshot forks a child process that serves the image until the clipboard is overwritten 🫶

Requires the clipboard feature (enabled by default).

🍓 Notification options

• --silent, --no-notifications — suppress the desktop notification after a screenshot.

Requires the notifications feature (enabled by default).

👑 Global options

• --config <PATH> — path to the config file. defaults to:
  • $XDG_CONFIG_HOME/wayshot/config.toml
  • $HOME/.config/wayshot/config.toml when $XDG_CONFIG_HOME is unset
  • built-in defaults when no file is found

Example: wayshot --config config.toml

• --log-level <LOG_LEVEL> — log level written to stderr. possible values: trace, debug, info, warn, error

Default value: info

Requires the logger feature (enabled by default).

---

🧚 FEATURES 🧚

wayshot supports optional Cargo features, bestie. all features are enabled by default in the official binary ✨ to build with a reduced set, use --no-default-features together with --features:

cargo build --no-default-features --features clipboard,logger

Available features: avif, clipboard, color_picker, completions, jpeg, jxl, logger, notifications, pnm, qoi, selector, webp

---

💜 SEE ALSO 💜

• wayshot(5)
• wayshot(7)

---

⭐ AUTHORS ⭐

Maintained by Shinyzenith <aakashsensharma@gmail.com> 💖 for more information about development, see https://github.com/waycrate/wayshot.

---

okay that's the whole page, bestie — go forth and screenshot slay 💅✨

this masterpiece lives at github.com/waycrate/wayshot, dated 1980-01-01, and the manual name is wayshot(1). periodt 🎀