Shinonome/caelestia-cli
1
0
Fork 1
mirror of https://github.com/caelestia-dots/cli.git synced 2026-06-05 14:59:29 -05:00
Code Issues Packages Projects Releases Wiki Activity

readme: document user templates (#99)

Browse Source 
* document user_templates in README

* move user_template documentation to Usage

* format

---------

Co-authored-by: 2 * r + 2 * t <61896496+soramanew@users.noreply.github.com>
This commit is contained in:
AteebXYZ
2026-03-20 12:56:12 +03:00
committed by GitHub
parent b023936e1d
commit 6bb09e7703
1 changed files with 36 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+33 -12
View File
@@ -4,33 +4,35 @@ The main control script for the Caelestia dotfiles.
<details><summary id="dependencies">External dependencies</summary> <details><summary id="dependencies">External dependencies</summary>
- [`libnotfy`](https://gitlab.gnome.org/GNOME/libnotify) - sending notifications - [`libnotfy`](https://gitlab.gnome.org/GNOME/libnotify) - sending notifications
- [`swappy`](https://github.com/jtheoof/swappy) - screenshot editor - [`swappy`](https://github.com/jtheoof/swappy) - screenshot editor
- [`grim`](https://gitlab.freedesktop.org/emersion/grim) - taking screenshots - [`grim`](https://gitlab.freedesktop.org/emersion/grim) - taking screenshots
- [`dart-sass`](https://github.com/sass/dart-sass) - discord theming - [`dart-sass`](https://github.com/sass/dart-sass) - discord theming
- [`app2unit`](https://github.com/Vladimir-csp/app2unit) - launching apps - [`app2unit`](https://github.com/Vladimir-csp/app2unit) - launching apps
- [`wl-clipboard`](https://github.com/bugaevc/wl-clipboard) - copying to clipboard - [`wl-clipboard`](https://github.com/bugaevc/wl-clipboard) - copying to clipboard
- [`slurp`](https://github.com/emersion/slurp) - selecting an area - [`slurp`](https://github.com/emersion/slurp) - selecting an area
- [`gpu-screen-recorder`](https://git.dec05eba.com/gpu-screen-recorder/about) - screen recording - [`gpu-screen-recorder`](https://git.dec05eba.com/gpu-screen-recorder/about) - screen recording
- `glib2` - closing notifications - `glib2` - closing notifications
- [`cliphist`](https://github.com/sentriz/cliphist) - clipboard history - [`cliphist`](https://github.com/sentriz/cliphist) - clipboard history
- [`fuzzel`](https://codeberg.org/dnkl/fuzzel) - clipboard history/emoji picker - [`fuzzel`](https://codeberg.org/dnkl/fuzzel) - clipboard history/emoji picker
</details> </details>
<details><summary id="optional-dependencies">Optional dependencies</summary> <details><summary id="optional-dependencies">Optional dependencies</summary>
- [`papirus-folders`](https://github.com/PapirusDevelopmentTeam/papirus-folders) - automatic folder icon color syncing with theme - [`papirus-folders`](https://github.com/PapirusDevelopmentTeam/papirus-folders) - automatic folder icon color syncing with theme
> [!NOTE] > [!NOTE]
> For automatic Papirus folder icon color syncing, `papirus-folders` needs to be able to run with `sudo` without a password prompt. > For automatic Papirus folder icon color syncing, `papirus-folders` needs to be able to run with `sudo` without a password prompt.
> >
> **Recommended** - Create a sudoers file: > **Recommended** - Create a sudoers file:
>
> ```fish > ```fish
> # Fish shell > # Fish shell
> echo "$USER ALL=(ALL) NOPASSWD: "(which papirus-folders) | sudo tee /etc/sudoers.d/papirus-folders > echo "$USER ALL=(ALL) NOPASSWD: "(which papirus-folders) | sudo tee /etc/sudoers.d/papirus-folders
> sudo chmod 440 /etc/sudoers.d/papirus-folders > sudo chmod 440 /etc/sudoers.d/papirus-folders
> ``` > ```
>
> ```sh > ```sh
> # Bash/other shells > # Bash/other shells
> echo "$USER ALL=(ALL) NOPASSWD: $(which papirus-folders)" | sudo tee /etc/sudoers.d/papirus-folders > echo "$USER ALL=(ALL) NOPASSWD: $(which papirus-folders)" | sudo tee /etc/sudoers.d/papirus-folders
@@ -38,6 +40,7 @@ The main control script for the Caelestia dotfiles.
> ``` > ```
> >
> **Alternatively** - Edit the main sudoers file by running `sudo visudo` and adding at the end: > **Alternatively** - Edit the main sudoers file by running `sudo visudo` and adding at the end:
>
> ``` > ```
> your_username ALL=(ALL) NOPASSWD: /usr/bin/papirus-folders > your_username ALL=(ALL) NOPASSWD: /usr/bin/papirus-folders
> ``` > ```
@@ -148,6 +151,24 @@ subcommands:
resizer window resizer daemon resizer window resizer daemon
``` ```
### User Templates
Custom user templates can be defined in `~/.config/caelestia/templates/`.
#### Template syntax
`{{ <color>.<format> }}`
- `<color>` is a theme color role derived from the Material You color system (e.g. `primary`, `secondary`, `background`)
- `<format>` is the output format: `hex` or `rgb`
#### Examples
- `{{ primary.hex }}` outputs `3f4ba2`
- `{{ primary.rgb }}` outputs `rgb(193, 132, 207)`
Output files are written to `~/.local/state/caelestia/theme/`. You can symlink them to your desired locations.
## Configuring ## Configuring
All configuration options are in `~/.config/caelestia/cli.json`. All configuration options are in `~/.config/caelestia/cli.json`.