academo / ww-run-raise

CLI tool to run or raise applications in KDE.
56 stars 12 forks source link

ww. Utility to raise or jump an applications in KDE. It interacts with KWin using KWin scripts and it is compatible with X11 and Wayland. It also works with multiple screens. It is intended as a wmctrl alternative (only for the raising windows part) compatible with wayland.

Installing

cp ww /usr/local/bin

Feel free to rename it

Usage

ww only works in KDE. It works in X11 and Wayland.

Example

if you want to raise or jump to an open firefox window:

ww -f firefox -c firefox

if you want to raise or jump to an app with an specific class:

ww -f kitty.terminal -c 'kitty --class kitty.terminal'

Note: In this example kitty allows you to pass the class option that sets the window class. This is a kitty feature, not a ww feature.

If you want to raise any window that matches a title. JS regexp allowed:

ww -fa 'Zoom meeting'

Paramaters:

-h  --help                show this help
-f  --filter              filter by window class
-fa --filter-alternative  filter by window title (caption)
-c  --command             command to check if running and run if no process is found

Create shortcuts

You can use KDE custom shortcuts to add a custom shortcut that calls ww

image

How does it work?

Internally ww uses 2 main things to work: pgrep and "on demand" KWin scripts.

When you run, for example ww -f firefox c -firefox, ww tries to find a process running with the exact command:

pgrep -o -f firefox

This detects if the application is running or not.

Then ww creates a file inside ~/.wwscripts to store a temporary kwin script, it loads the script, runs it, stops it and unloads it in a single go.

The kwin script is targeted to find and focus a specific window.

TODO

Here some ideas of improvements that I'd like to explore, but my knowledge on kwin scripts doesn't allow me: