mirror of
https://github.com/prdlk/dotfiles.git
synced 2026-11-02 11:32:42 +00:00
docs(docs): add vicinae documentation and update references
This commit is contained in:
1 parent
958a7a8e45
commit
fd1e822450
15 files changed
+119
-34
No files matched your search
@@ -6,7 +6,7 @@ sidebar:
|
||||
---
|
||||
|
||||
:::note[Role gating]
|
||||
`.chezmoiignore.tmpl` skips the Linux desktop layer unless the machine runs Linux **and** its role is `desktop` or `laptop`. The gated targets are `~/.config/niri`, `~/.config/hypr`, `~/.config/noctalia`, `~/.config/niri-dynamic-workspaces`, `~/.config/fontconfig`, `~/.config/mimeapps.list`, `~/.config/systemd`, `~/.local/bin/kitty-day-save`, `~/.local/bin/niri-launch`, `~/.local/bin/cp-appid`, `~/.local/bin/projects-sync`, and `~/.config/fish/auto-Niri.fish`. On `mac` and `server` roles these are not applied.
|
||||
`.chezmoiignore.tmpl` skips the Linux desktop layer unless the machine runs Linux **and** its role is `desktop` or `laptop`. The gated targets are `~/.config/niri`, `~/.config/hypr`, `~/.config/noctalia`, `~/.config/vicinae`, `~/.config/niri-dynamic-workspaces`, `~/.config/fontconfig`, `~/.config/mimeapps.list`, `~/.config/systemd`, `~/.local/bin/kitty-day-save`, `~/.local/bin/niri-launch`, `~/.local/bin/cp-appid`, `~/.local/bin/projects-sync`, and `~/.config/fish/auto-Niri.fish`. On `mac` and `server` roles these are not applied.
|
||||
|
||||
`~/.config/waybar`, the `omarchy-*` scripts, the `niri-launch-ai` / `-browser` / `-terminal` / `-webapp` wrappers, and `~/.local/bin/tmux-niri-title` are **not** listed there, so chezmoi applies them on every role and OS. Only the exact path `.local/bin/niri-launch` is ignored, not the wrappers that call it.
|
||||
:::
|
||||
@@ -19,6 +19,7 @@ Two Wayland compositors are configured side by side. niri is the original setup,
|
||||
| [Hyprland](/desktop/hyprland) | `~/.config/hypr` Lua config on Omarchy: bindings, input, look and feel, monitors, hyprsunset, the portal; every `omarchy-*` script in `~/.local/bin` |
|
||||
| [Waybar](/desktop/waybar) | `~/.config/waybar`: module layout, stylesheet, the `window_pill.py` title module |
|
||||
| [Fonts and default apps](/desktop/fonts-and-apps) | `~/.config/fontconfig/fonts.conf`, `~/.config/mimeapps.list`, the Victor Mono Nerd Font packages |
|
||||
| [vicinae](/desktop/vicinae) | `~/.config/vicinae/settings.json`: launcher keybindings, font, extension shortcuts and aliases |
|
||||
|
||||
## Packages
|
||||
|
||||
@@ -27,6 +28,6 @@ Two Wayland compositors are configured side by side. niri is the original setup,
|
||||
| Source | Packages |
|
||||
| --- | --- |
|
||||
| pacman | `niri`, `xdg-user-dirs` |
|
||||
| AUR (via `paru`) | `noctalia-shell` |
|
||||
| AUR (via `paru`) | `noctalia-shell`, `vicinae-bin` |
|
||||
|
||||
The script skips AUR packages with a warning if `paru` is not installed. Hyprland, Waybar, and the `omarchy-*` commands that the scripts call (`omarchy-menu`, `omarchy-launch-or-focus`, and others) come from an Omarchy install. This repo does not install them. See [chezmoi scripts](/chezmoi/scripts) for the full install flow.
|
||||
@@ -3,5 +3,5 @@ import { defineMeta } from "blume";
|
||||
export default defineMeta({
|
||||
title: "Desktop",
|
||||
icon: "monitor",
|
||||
pages: ["index", "niri", "hyprland", "waybar", "fonts-and-apps"],
|
||||
pages: ["index", "niri", "hyprland", "waybar", "fonts-and-apps", "vicinae"],
|
||||
});
|
||||
@@ -55,9 +55,9 @@ Linux `desktop` and `laptop` roles only. `.chezmoiignore.tmpl` skips `~/.config/
|
||||
|
||||
## Installation
|
||||
|
||||
- `niri` and `xdg-user-dirs` from pacman, `noctalia-shell` from the AUR. Declared under `packages.arch.desktop` in `.chezmoidata/packages.yaml` and installed by `run_onchange_before_10-packages.sh.tmpl` for `desktop`/`laptop` roles. See [chezmoi scripts](/chezmoi/scripts).
|
||||
- `niri` and `xdg-user-dirs` from pacman, `noctalia-shell` and `vicinae-bin` from the AUR. Declared under `packages.arch.desktop` in `.chezmoidata/packages.yaml` and installed by `run_onchange_before_10-packages.sh.tmpl` for `desktop`/`laptop` roles. See [chezmoi scripts](/chezmoi/scripts).
|
||||
- `.chezmoiscripts/run_once_after_30-user-services.sh.tmpl` runs once on Linux. If `~/.config/systemd/user/nirinit.service` exists, it runs `systemctl --user daemon-reload` and `systemctl --user enable nirinit.service`. The script's comment says other personal units (brain-lens, omp-loop, rclone, hermes, voxtype) ship as files only and are enabled by hand. The repo does not currently contain `dot_config/systemd`, so the unit must come from elsewhere for the enable step to run.
|
||||
- Tools the config calls but does not install: `vicinae`, `cliphist`/`wl-paste`, `polkit-gnome`, `kbuildsycoca6`, `voxtype`, `niri-dynamic-workspaces`, `dot-screenshot`, `niri-smart-close`, `niri-smart-move`, and the `capitaine-cursors-light` cursor theme. `niri-smart-close`, `niri-smart-move`, and `dot-screenshot` are called by path or name but are not in this repo.
|
||||
- Tools the config calls but does not install: `cliphist`/`wl-paste`, `polkit-gnome`, `kbuildsycoca6`, `voxtype`, `niri-dynamic-workspaces`, `dot-screenshot`, `niri-smart-close`, `niri-smart-move`, and the `capitaine-cursors-light` cursor theme. `niri-smart-close`, `niri-smart-move`, and `dot-screenshot` are called by path or name but are not in this repo. [vicinae](/desktop/vicinae) is installed and configured here.
|
||||
|
||||
## Load order
|
||||
|
||||
|
||||
@@ -0,0 +1,59 @@
|
||||
---
|
||||
title: vicinae
|
||||
description: The vicinae launcher — global shortcuts, font, and per-extension aliases and shortcuts.
|
||||
---
|
||||
|
||||
[vicinae](https://vicinae.com) is the launcher under both niri and Hyprland: app search, emoji picker, clipboard history, window switcher, and store extensions.
|
||||
|
||||
| | |
|
||||
| --- | --- |
|
||||
| Source | `dot_config/vicinae/settings.json` |
|
||||
| Target | `~/.config/vicinae/settings.json` |
|
||||
| Install | `vicinae-bin` under `packages.arch.desktop.aur` in `.chezmoidata/packages.yaml` |
|
||||
|
||||
:::note
|
||||
Linux `desktop` and `laptop` roles only. `.chezmoiignore.tmpl` skips `~/.config/vicinae/**` on other roles.
|
||||
:::
|
||||
|
||||
`settings.json` is merged over `vicinae config default`. vicinae rewrites the file whenever a setting changes in its GUI, dropping comments and formatting; in symlink mode that write lands in the repo, so check `git status` after changing settings in the UI.
|
||||
|
||||
Runtime state (`~/.local/share/vicinae`: clipboard database, extension installs, search history, favicons) is not managed. Extensions referenced below are installed from the vicinae store on each machine.
|
||||
|
||||
## General
|
||||
|
||||
| Option | Value |
|
||||
| --- | --- |
|
||||
| `keybinding` | `vim` |
|
||||
| `close_on_focus_loss` / `pop_to_root_on_close` | `true` |
|
||||
| `font.normal` | `VictorMono NFP` 9.5, `rendering = native` |
|
||||
| `theme.dark.icon_theme` | `Yaru` |
|
||||
| `launcher_window` | compact mode off, no floating status bar |
|
||||
|
||||
## Shortcuts
|
||||
|
||||
Global and per-entrypoint shortcuts. The compositor bindings in [niri](/desktop/niri) / [Hyprland](/desktop/hyprland) call `vicinae toggle` and deeplinks for the same features; these are vicinae's own bindings.
|
||||
|
||||
| Key | Entrypoint |
|
||||
| --- | --- |
|
||||
| `super+SPACE` | `global_shortcuts.toggle` |
|
||||
| `super+shift+SPACE` | `core` / search-emojis |
|
||||
| `super+P` | `clipboard` / history |
|
||||
| `super+A` | `system` / browse-apps |
|
||||
| `alt+SPACE` | `@codingcodax/store.vicinae.omarchy-menu` |
|
||||
| `super+control+shift+O` | `@aurelleb/store.vicinae.chromium-bookmarks` / search-bookmarks |
|
||||
|
||||
## Aliases
|
||||
|
||||
| Alias | Entrypoint |
|
||||
| --- | --- |
|
||||
| `apps` | `system` / browse-apps |
|
||||
| `sh` | `system` / run |
|
||||
| `pass` | `applications` / 1password |
|
||||
| `photoshop`, `illustrator` | `applications` / photocraft, vectorcraft |
|
||||
| `nf` | `@fbosch/store.vicinae.nerdfont-search` |
|
||||
| `aur` | `@rithvikvibhu/store.vicinae.arch-packages` |
|
||||
| `cql` | `manage-shortcuts` / create |
|
||||
| `shut down`, `restart` | `power` / power-off, reboot |
|
||||
| `streams` | `shortcuts` / `sct-a5e51f1bbe34` (a user shortcut; the id is machine-specific) |
|
||||
|
||||
`system` / set-default-browser and set-default-terminal are disabled.
|
||||
Reference in new issue
Block a user