https://github.com/faetalize/waytator
Wayland image annotation tool
https://github.com/faetalize/waytator
Last synced: 3 months ago
JSON representation
Wayland image annotation tool
- Host: GitHub
- URL: https://github.com/faetalize/waytator
- Owner: faetalize
- License: gpl-3.0
- Created: 2026-04-12T15:18:54.000Z (3 months ago)
- Default Branch: master
- Last Pushed: 2026-04-24T09:11:50.000Z (3 months ago)
- Last Synced: 2026-04-24T11:39:33.034Z (3 months ago)
- Language: C
- Homepage:
- Size: 310 KB
- Stars: 20
- Watchers: 0
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# waytator
`waytator` is a screenshot annotator and lightweight image editor
`niri` user? Check below on how to integrate niri screenshots with this tool
## Build & Install
### Arch
Get it from the AUR:
```bash
yay -S waytator
```
### From source
1) Required build dependencies:
- `meson`
- `ninja`
- `pkg-config`
- `gtk4`
- `libadwaita-1`
- a C compiler such as `gcc` or `clang`
2) Recommended runtime dependency:
- `tesseract` for OCR support
- `wl-clipboard` for niri screenshot clipboard support
3) Install into `~/.local`:
```bash
meson setup build --buildtype=release --prefix="$HOME/.local" # Override the prefix if needed
meson compile -C build
meson install -C build
```
This installs:
- the `waytator` binary to `${HOME}/.local/bin/waytator`
- the desktop entry to `${HOME}/.local/share/applications/dev.faetalize.waytator.desktop`
- the app icon to `${HOME}/.local/share/icons/hicolor/scalable/apps/dev.faetalize.waytator.svg`
The app's identifier is `dev.faetalize.waytator` for concerns such as the desktop entry and icon, so if you have an older version of the app installed with a different identifier (e.g. `dev.waytator.Waytator`), make sure to remove it first to avoid conflicts.
If `~/.local/bin` is not already on your `PATH`, add it in your shell profile. For example, add the following line to `~/.bashrc`:
```bash
export PATH="$HOME/.local/bin:$PATH"
```
If launchers fail to start `waytator` after installing from source, make sure your graphical session includes `~/.local/bin` in `PATH`, not just your shell configuration.
## Usage
Read from stdin automatically when image data is piped in:
```bash
grim -g "$(slurp)" - | waytator
```
Or pass stdin explicitly:
```bash
grim -g "$(slurp)" - | waytator --stdin
```
Set the default display/save-as name for stdin images:
```bash
grim -g "$(slurp)" - | waytator --stdin --name "Screenshot.png"
```
Open an existing image:
```bash
waytator path/to/image.png
```
It can also be run independently:
```bash
waytator
```
If you're on niri, just bind your screenshot keybind to `./scripts/screenshot-to-waytator.sh`, this will automatically open screenshots into `waytator` after they are captured for editing. Saving from niri's screenshot UI opens the saved file; pressing `Ctrl+C` in the screenshot UI opens the copied image directly from the clipboard. Clipboard captures use a timestamped name by default; override it with `WAYTATOR_SCREENSHOT_NAME`.
```kdl
// in your config.kdl, in the binds section
Print { spawn ; }
Mod+Shift+S { spawn ; }
```
I recommend adding a window rule to float `waytator` windows for better experience, for example with `niri`:
```kdl
// in your config.kdl
window-rule {
match app-id=r#"^dev\.faetalize\.waytator$"#
open-floating true
}
```
## License
GPL-3.0-or-later.