✨ Features

📦 Install

Quick start

git clone https://github.com/<you>/dotfiles.git ~/dotfiles
cd ~/dotfiles
./install.sh --all

That installs the packages, the Nerd Font, and links every config into ~/.config. Then log out, choose "Sway" on the login screen, and log in.

💡 Not sure? Run ./install.sh --all --dry-run first. It prints every step without changing anything.

Step by step

1. Clone the repo anywhere you like (the configs are symlinked, so keep the folder):

git clone https://github.com/<you>/dotfiles.git ~/dotfiles && cd ~/dotfiles

2. Install the programs. The installer detects your package manager:

./install.sh --packages

sudo apt install $(grep -vE '^\s*(#|$)' packages/apt.txt)

sudo pacman -S --needed $(grep -vE '^\s*(#|$)' packages/pacman.txt)
# wlogout is in the AUR:  yay -S wlogout

sudo dnf install --skip-unavailable $(grep -vE '^\s*(#|$)' packages/dnf.txt)

3. Install the icon font (JetBrainsMono Nerd Font, downloaded into ~/.local/share/fonts):

./install.sh --fonts

4. Link the configs. Anything already in ~/.config/<app> is moved to ~/.local/state/dotfiles/backups/<date>/ first:

./install.sh            # all apps
./install.sh waybar mako  # or only some

5. Check that nothing is missing:

./install.sh --check

6. Start sway

• From a login screen (GDM, SDDM, …): log out, click the gear / session menu, pick Sway.

• From a TTY: log in and run sway. To start it automatically on TTY1, add this to ~/.profile (or ~/.zprofile):

  if [ -z "$WAYLAND_DISPLAY" ] && [ "$(tty)" = "/dev/tty1" ]; then
      exec sway
  fi
  

Installer options

./install.sh [options] [module ...]

  -a, --all         Full setup: packages + fonts + symlinks
  -p, --packages    Install dependencies (apt, pacman or dnf)
  -f, --fonts       Download JetBrainsMono Nerd Font
  -l, --link        Symlink configs into ~/.config  (default)
  -c, --check       Show which required programs are missing
  -u, --uninstall   Remove the symlinks and restore your latest backup
  -n, --dry-run     Print what would happen, change nothing
  -y, --yes         Don't ask for confirmation

Prefer make? make help lists the same actions (make all, make link, make check, make lint, make reload, make uninstall).

Updating

Because everything is symlinked, updating is just:

cd ~/dotfiles && git pull && make reload

Uninstall

./install.sh --uninstall

Removes the symlinks and puts your previous configs back from the latest backup.

⌨️ Keybindings

Super is the Windows key. Press Super + / at any time for the full searchable list.

Essentials

Windows & layout

Tools

📊 Waybar

╭────────────────────────────────────────────────────────────────────────────────────────────────╮
│ launcher  workspaces  ▶ media  │       clock       │  weather  cpu▸  vol  light  net  bt  bat   │
│                                │                   │  updates  caffeine  night  dnd  tray  power│
╰────────────────────────────────────────────────────────────────────────────────────────────────╯

🗂 Structure

dotfiles/
├── install.sh                 # installer (packages, fonts, links, backup, uninstall)
├── Makefile                   # make all / link / check / lint / reload / uninstall
├── packages/                  # package lists: apt.txt, pacman.txt, dnf.txt
├── wallpapers/                # default wallpapers (Catppuccin)
└── config/                    # each folder → ~/.config/<folder>
    ├── sway/
    │   ├── config             # variables + colour palette
    │   ├── config.d/
    │   │   ├── 10-appearance.conf
    │   │   ├── 20-input.conf      # keyboard layout, touchpad
    │   │   ├── 30-output.conf     # monitors
    │   │   ├── 40-keybindings.conf
    │   │   ├── 50-modes.conf      # resize, passthrough, system
    │   │   ├── 60-rules.conf      # floating windows, PiP, idle inhibit
    │   │   ├── 70-bar.conf
    │   │   └── 80-autostart.conf
    │   └── scripts/           # volume, brightness, screenshot, powermenu,
    │                          # clipboard, emoji, colorpicker, keybinds,
    │                          # wallpaper, nightlight, dnd, idle, dropterm …
    ├── waybar/                # config.jsonc, style.css, scripts/ (weather, updates)
    ├── wofi/                  # launcher + dmenu theme
    ├── foot/  kitty/          # terminals
    ├── mako/                  # notifications (+ Do Not Disturb mode)
    ├── swaylock/              # lock screen
    ├── wlogout/               # graphical power menu
    ├── gammastep/             # night light
    └── swappy/                # screenshot annotation

🛠 Customising

Machine-specific settings go in config/sway/config.d/99-local.conf. It's git-ignored and loaded last, so it overrides everything:

# 99-local.conf
output eDP-1    scale 1.25
output HDMI-A-1 position 1920,0
input type:keyboard xkb_layout us,de
set $browser chromium

After editing: Super + Shift + C reloads sway (waybar and mako reload with it). make lint checks the sway config for errors.

🩺 Troubleshooting

🙏 Credits

• Colours: Catppuccin (MIT)
• Sway · Waybar · Nerd Fonts · wttr.in

Feel free to fork, copy and adapt anything here.