diff options
| author | 2 * r + 2 * t <61896496+soramanew@users.noreply.github.com> | 2025-06-09 00:33:16 +1000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-06-09 00:33:16 +1000 |
| commit | 4d002df1181e0ece60db4745fcf81da300e5c586 (patch) | |
| tree | a799010196c2b784aa7ca76ecf3171b3a61183d9 /README.md | |
| parent | internal: fix run shebang (diff) | |
| download | caelestia-shell-4d002df1181e0ece60db4745fcf81da300e5c586.tar.gz caelestia-shell-4d002df1181e0ece60db4745fcf81da300e5c586.tar.bz2 caelestia-shell-4d002df1181e0ece60db4745fcf81da300e5c586.zip | |
readme: add how to start in usage section
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 17 |
1 files changed, 17 insertions, 0 deletions
@@ -30,6 +30,23 @@ clone this repo into `$XDG_CONFIG_HOME/quickshell/caelestia` and run `qs -c cael ## Usage +The shell can be started in two ways: via systemd or manually running `caelestia shell`. + +### Via systemd + +The install script creates and enables the systemd service `caelestia-shell.service` which should automatically start the +shell on login. + +### Via command + +If not on a system that uses systemd, you can manually start the shell via `caelestia-shell`. +To autostart it on login, you can use an `exec-once` rule in your Hyprland config: +``` +exec-once = caelestia shell +``` + +### Shortcuts/IPC + All keybinds are accessible via Hyprland [global shortcuts](https://wiki.hyprland.org/Configuring/Binds/#dbus-global-shortcuts). For a preconfigured setup, install [`caelestia-hypr`](https://github.com/caelestia-dots/hypr) via `caelestia install hypr` or see [this file](https://github.com/caelestia-dots/hypr/blob/main/hyprland/keybinds.conf#L1-L29) for an example on how to use global |