mirror of
https://github.com/LGUG2Z/komorebi.git
synced 2026-11-22 00:21:43 +01:00
feat(cli): komorebic
The daemon answers on its socket, but a person has no way to write a message on it. komorebic is that way: each subcommand that asks something of the daemon is one message, sent with komorebi-client, and a question's answer is printed. komorebic is a separate program because the daemon takes no input but its socket, so a key binding, a script and a terminal all drive it the same way. It has what the daemon can answer so far: state, monitor-information, query, retile and stop. Around them, start runs the komorebi on the PATH in the background and passes it what follows a --, such as --fake-backend to try it without a compositor; log follows the daemon's log, which the daemon now writes to a file a day in LOG_DIR as well as to stdout; data-directory shows where the socket is; completions prints a shell completion script. The hidden docgen writes each subcommand's help to docs/cli, in fences that name their language and wrapped at 100 columns whatever the width of the terminal, so that the pages are the same wherever they are generated; just docgen runs it. The user guide starts here: docs/index.md for KDE Plasma, and a page on running komorebi. tests/cli.rs runs each subcommand against a socket the test serves in place of the daemon. In the VM tests the guests get komorebic next to the daemon, and vm-core-e2e reads the daemon's state with it (the windows it manages, the one it focuses, after KWin restarts too) and stops it with komorebic stop, which unloads the bridge and removes the socket. In the VM test library, Kde.state asks again, a second (times the scale) after an empty answer or a failed command, up to 10 times. The daemon drops a query when it cannot take hold of the window manager within a second, and komorebic then prints an empty line and succeeds; komorebic itself gives the daemon a second to answer and fails when that is not enough. A daemon busy with the first windows does either on a machine that is loaded or slow, and a suite that polled the state died on JSONDecodeError. An answer that is not JSON still fails at once.
This commit is contained in:
1 parent
88aa78b874
commit
6f657e53e3
36 files changed
+1320
-39
No files matched your search
@@ -0,0 +1,98 @@
|
||||
# Running komorebi
|
||||
|
||||
`komorebi` is the daemon that tiles your windows, and `komorebic` is the command line you
|
||||
control it with. This page covers starting and stopping the daemon, asking it what it is
|
||||
doing, and reading its log.
|
||||
|
||||
## Getting the two programs
|
||||
|
||||
On Linux, the flake's default package has both: in a checkout of the repository,
|
||||
`nix build` leaves them in `result/bin`, and `nix profile install .` puts them on your
|
||||
`PATH`. Without nix, build them with the Rust toolchain that `rust-toolchain.toml`
|
||||
selects:
|
||||
|
||||
```sh
|
||||
cargo build --release --locked
|
||||
export PATH="$PWD/target/release:$PATH"
|
||||
```
|
||||
|
||||
## Starting and stopping
|
||||
|
||||
[`komorebic start`](../cli/start.md) runs the `komorebi` on your `PATH` in the background,
|
||||
and checks three seconds later that it is running. It tries three times. If `komorebi` has
|
||||
not started by then, `komorebic start` runs it once more in the foreground and prints what
|
||||
it wrote on its standard error, which explains why it did not start. When a `komorebi` is
|
||||
running already, `komorebic start` does nothing.
|
||||
|
||||
`komorebi` manages the windows of the Plasma Wayland session it is started in: it connects
|
||||
to KWin on the session bus and loads a script into it, so start it from a terminal in that
|
||||
session. Outside a Plasma session it exits with an error that says what is missing, which
|
||||
`komorebic start` prints.
|
||||
|
||||
Everything after a `--` is passed to `komorebi`. `--fake-backend` runs it against an
|
||||
in-memory desktop with one monitor and no windows instead of KWin, which is a way to try the
|
||||
daemon and `komorebic` without a compositor:
|
||||
|
||||
```sh
|
||||
komorebic start
|
||||
komorebic start -- --log-level debug
|
||||
komorebic start -- --fake-backend
|
||||
```
|
||||
|
||||
[`komorebic stop`](../cli/stop.md) tells the daemon to stop. It asks KWin to unload its
|
||||
script, removes its socket and exits. Stopping the process with `SIGINT` or `SIGTERM` does
|
||||
the same.
|
||||
|
||||
## Asking komorebi what it is doing
|
||||
|
||||
The daemon answers questions on its socket, and these commands print the answers:
|
||||
|
||||
- [`komorebic state`](../cli/state.md): every monitor, with its workspaces, their
|
||||
containers and the windows in them, as JSON.
|
||||
- [`komorebic monitor-information`](../cli/monitor-information.md): the id, the name and
|
||||
the bounds of every monitor, as JSON.
|
||||
- [`komorebic query`](../cli/query.md): one value, the answer to one question: the index of
|
||||
the focused monitor, workspace, container or window, the layout of the focused workspace,
|
||||
whether the focused container is a single window or a stack, or the version of the
|
||||
daemon.
|
||||
|
||||
```sh
|
||||
komorebic query focused-workspace-index
|
||||
komorebic state | jq '.monitors.elements[0].workspaces.elements[0].containers.elements | length'
|
||||
```
|
||||
|
||||
[`komorebic retile`](../cli/retile.md) tiles the windows of every monitor again, which puts
|
||||
a window that was moved by hand back on its tile.
|
||||
|
||||
When the daemon is not running, these commands fail: there is no socket to write to.
|
||||
|
||||
## The socket and the data directory
|
||||
|
||||
The daemon listens on `komorebi.sock` in its data directory, `$XDG_RUNTIME_DIR/komorebi`
|
||||
(the local data directory, `~/.local/share/komorebi`, when there is no runtime directory).
|
||||
[`komorebic data-directory`](../cli/data-directory.md) prints the directory, if it exists.
|
||||
|
||||
## The log
|
||||
|
||||
The daemon logs to its standard output and to a file a day in `~/.local/share/komorebi`
|
||||
(`$XDG_DATA_HOME/komorebi` when that is set): `komorebi.log.YYYY-MM-DD`, with colors, and
|
||||
`komorebi_plaintext.log.YYYY-MM-DD`, without. The day is the UTC date.
|
||||
|
||||
[`komorebic log`](../cli/log.md) follows the file of the current day, with colors, until
|
||||
you press Ctrl-C. The `--log-level` of `komorebi` sets how much is logged: `error`, `warn`,
|
||||
`info` (the default), `debug` or `trace`.
|
||||
|
||||
## Shell completions
|
||||
|
||||
[`komorebic completions`](../cli/completions.md) prints a completion script for bash,
|
||||
elvish, fish, PowerShell or zsh:
|
||||
|
||||
```sh
|
||||
komorebic completions fish > ~/.config/fish/completions/komorebic.fish
|
||||
komorebic completions bash > ~/.local/share/bash-completion/completions/komorebic
|
||||
```
|
||||
|
||||
## Every command
|
||||
|
||||
[`docs/cli`](../cli/start.md) has a page for every `komorebic` command, generated from its
|
||||
help with `just docgen`.
|
||||
Reference in new issue
Block a user