This is the main repo of the caelestia dots and contains the user configs for apps. This repo also includes an install script to install the entire dots.
Simply clone this repo and run the install script (you need
fish
installed).
Warning
The install script symlinks all configs into place, so you CANNOT
move/remove the repo folder once you run the install script. If
you do, most apps will not behave properly and some (e.g. Hyprland)
will fail to start completely. I recommend cloning the repo to
~/.local/share/caelestia
.
The install script has some options for installing configs for some apps.
$ ./install.fish -h
usage: ./install.sh [-h] [--noconfirm] [--spotify] [--vscode] [--discord] [--paru]
options:
-h, --help show this help message and exit
--noconfirm do not confirm package installation
--spotify install Spotify (Spicetify)
--vscode=[codium|code] install VSCodium (or VSCode)
--discord install Discord (OpenAsar + Equicord)
--zen install Zen browser
--paru use paru instead of yay as AUR helper
For example:
git clone https://github.com/caelestia-dots/caelestia.git ~/.local/share/caelestia
~/.local/share/caelestia/install.fish
Dependencies:
- hyprland
- xdg-desktop-portal-hyprland
- xdg-desktop-portal-gtk
- hyprpicker
- hypridle
- wl-clipboard
- cliphist
- bluez-utils
- inotify-tools
- app2unit
- wireplumber
- trash-cli
- foot
- fish
- fastfetch
- starship
- btop
- jq
- socat
- imagemagick
- curl
- adw-gtk-theme
- papirus-icon-theme
- qt5ct-kde
- qt6ct-kde
- ttf-jetbrains-mono-nerd
Install all dependencies and follow the installation guides of the shell and cli to install them.
Tip
If on Arch or an Arch-based distro, there is a meta package available in the AUR
that pulls in all dependencies (caelestia-meta
).
Then copy or symlink the hypr
, foot
, fish
, fastfetch
, uwsm
and btop
folders to the
$XDG_CONFIG_HOME
(usually ~/.config
) directory. e.g. hypr -> ~/.config/hypr
.
Copy starship.toml
to $XDG_CONFIG_HOME/starship.toml
.
Follow the Spicetify installation instructions,
copy or symlink the spicetify
folder to $XDG_CONFIG_HOME/spicetify
and run
spicetify config current_theme caelestia color_scheme caelestia custom_apps marketplace
spicetify apply
Install VSCode or VSCodium, then copy or symlink vscode/settings.json
and
vscode/keybindings.json
into the $XDG_CONFIG_HOME/Code/User
(or $XDG_CONFIG_HOME/VSCodium/User
if using VSCodium) folder. Then copy or symlink vscode/flags.conf
to $XDG_CONFIG_HOME/code-flags.conf
(or $XDG_CONFIG_HOME/codium-flags.conf
if using VSCodium).
Finally, install the extension VSIX from vscode/caelestia-vscode-integration
.
# Use `codium` if using VSCodium
code --install-extension vscode/caelestia-vscode-integration/caelestia-vscode-integration-*.vsix
Install Zen Browser, then copy or symlink zen/userChrome.css
to the chrome
folder in your
profile of choice in ~/.zen
. e.g. zen/userChrome.css -> ~/.zen/<profile>/chrome/userChrome.css
.
Now install the native app by copying zen/native_app/manifest.json
to
~/.mozilla/native-messaging-hosts/caelestiafox.json
and replacing the {{ $lib }}
string in it
with the absolute path of ~/.local/lib/caelestia
(this must be the absolute path, e.g.
/home/user/.local/lib/caelestia
). Then copy or symlink zen/native_app/app.fish
to
~/.local/lib/caelestia/caelestiafox
.
Finally, install the CaelestiaFox extension from here.
Simply run yay
to update the AUR packages, then cd
into the repo directory and run git pull
to update the configs.
Note
These dots do not contain a login manager (for now), so you must install a
login manager yourself unless you want to log in from a TTY. I recommend
greetd
with
tuigreet
, however you can use
any login manager you want.
There aren't really any usage instructions... these are a set of dotfiles.
Here's a list of useful keybinds though:
Super
- open launcherSuper
+#
- switch to workspace#
Super
Alt
+#
- move window to workspace#
Super
+T
- open terminal (foot)Super
+W
- open browser (zen)Super
+C
- open IDE (vscodium)Super
+S
- toggle special workspace or close current special workspaceCtrl
Alt
+Delete
- open session menuCtrl
Super
+Space
- toggle media play stateCtrl
Super
Alt
+R
- restart the shell