Dotfiles

Configurations, tools, and setup scripts for *nix systems.

Installation

To install the dotfiles:

• Install Homebrew on MacOS: https://brew.sh/.
• Download and run the installer using one of the following commands:

wget -O - https://codeberg.org/andreihh/dotfiles/raw/branch/main/install.sh \
  | sh -s -- -s

curl -Lo - https://codeberg.org/andreihh/dotfiles/raw/branch/main/install.sh \
  | sh -s -- -s

• Log out and back in to ensure the environment is loaded properly.
• Run pre-commit install inside the repository to configure pre-commit checks.

To update the dotfiles, run install.sh from the repository in a clean state.

Exporting HEADLESS to a non-empty value will skip installation of GUI packages and configs.

XDG directories

The dotfiles follow the XDG specification where possible:

• https://specifications.freedesktop.org/basedir-spec/latest/index.html
• https://wiki.archlinux.org/title/XDG_Base_Directory

If not already set, the XDG environment variables are exported with default values in ${HOME}/.config/env.d/00-xdg.sh because some tools don't fall back on proper defaults and only work if they are explicitly defined.

Private configs

User or device specific configs and binaries that should not be included in the repository can be provided in:

• ${HOME}/.local/bin/
• ${XDG_CONFIG_HOME:-${HOME}/.config}/env.d/
• ${XDG_CONFIG_HOME:-${HOME}/.config}/sh.d/
• ${XDG_CONFIG_HOME:-${HOME}/.config}/tmux/overrides.tmux
• ${XDG_CONFIG_HOME:-${HOME}/.config}/nvim/lua/config/overrides.lua
• ${XDG_CONFIG_HOME:-${HOME}/.config}/nvim/lua/plugins/
• ${XDG_CONFIG_HOME:-${HOME}/.config}/nvim/[after/]lsp/
• ${XDG_CONFIG_HOME:-${HOME}/.config}/vim/overrides.vim

Example ${XDG_CONFIG_HOME:-${HOME}/.config}/sh.d/10-extras.sh:

# extras.sh: exports device-specific settings.

# Export Git credentials.
export GIT_AUTHOR_NAME='Andrei Heidelbacher'
export GIT_COMMITTER_NAME="${GIT_AUTHOR_NAME}"
...

Example ${XDG_CONFIG_HOME:-${HOME}/.config}/nvim/lua/config/overrides.lua:

-- [[ Config overrides ]]

-- Ensure development tools are installed by Mason.
--
-- Installs `tree-sitter-cli` automatically. Run `:TSInstall stable unstable`
-- afterwards to install Treesitter parsers.
vim.g.ensure_installed = {
  -- General formatting
  "prettier",
  -- Lua
  "lua-language-server",
  "stylua",
  -- Vimscript
  "vim-language-server",
  -- Bash
  "bash-language-server",
  "shfmt",
  "shellcheck", -- integrates with `bash-language-server`
  -- Python
  "pyright",
  "isort",
  "black",
  "pylint",
  -- C/C++
  "clangd",
  "clang-format",
  -- Java
  "jdtls",
  "google-java-format",
  "checkstyle",
}

-- Start LSPs automatically.
--  Override configs with `vim.lsp.config()`.
--  See `:help vim.lsp.Config`
vim.lsp.enable({
  "lua_ls",
  "vimls",
  "bashls",
  "pyright",
  "clangd",
  "jdtls",
})

-- Configure formatters.
--  See `:help conform`
vim.g.format_opts = {
  formatters_by_ft = {
    markdown = { "prettier" },
    yaml = { "prettier" },
    json = { "prettier" },
    lua = { "stylua" },
    sh = { "shfmt" },
    python = { "isort", "black" },
    cpp = { "clang-format" },
    java = { "google-java-format" },
  },
}

-- Configure linters.
--  See `:help lint`
vim.g.lint_opts = {
  linters_by_ft = {
    python = { "pylint" },
    -- `clangd` embeds `clang-tidy`
    java = { "checkstyle" },
  },
}

Hotkeys

Keyboard layout changes:

• Swap Caps Lock with Esc
• Linux modifiers: Super Alt Ctrl Space Alt Ctrl
• MacOS modifiers: Ctrl Opt Cmd Space Opt Cmd

Common shortcuts (C = Ctrl / Cmd, A = Alt / Opt, S = Shift):

• New tab: C-t
• Close window / tab: C-w
• Quit app: C-q
• Cycle web browser tabs: C-{12}
• Cycle windows: C-[S]-Tab
• Switch to workspace: A-{1-9}
• Move window to workspace: C-A-{1-9}
• Move window to left / right monitor: C-A-{,.}
• Toggle window tiled left / right: C-A-{hl}
• Toggle window maximized / fullscreen: A-[S]-z
• Print screen / cancel: A-p / Esc
• Record screen / cancel: A-r / Esc
• Toggle play media: A-Enter
• Toggle mute volume / microphone: A-[S]-Backspace
• Adjust volume: A-{-=}
• Adjust screen brightness: A-S-{-=}
• Focus notification / dismiss: A-n / Esc
• Open notification center: A-S-n
• Open settings: A-S-s
• Open web browser: A-w
• Open email client: A-e
• Open file explorer: A-f
• Open terminal: A-x
• Open tmux terminal: A-S-x
• Open SSH tmux terminal to cloud workstation: A-c
• Open app launcher: A-a
• Lock screen / log out: A-[S]-Esc
• Restart / shutdown: A-[S]-`

Terminal:

• Reload config: C-S-r
• Send SIGINT: C-c
• Paste: C-S-v
• Select next / previous command: C-{np}
• Search command history: C-r
• Trigger completion (path / process id / etc.): **<tab>
• Switch tmux tab: C-{1-9} (mapped to A-{1-9})
• Close tmux / nvim / vim tab: C-S-x (mapped to A-x)
• Resize tmux / nvim / vim windows: C-S-{hjkl=} (mapped to A-{hjkl=})
• Save nvim / vim session: C-S-s (mapped to A-s)

Licensing

The scripts and configurations are licensed under the MIT license.

The data/wallpapers/catppuccin.svg and data/wallpapers/catppuccin-debian.svg files were derived from Alex Makas's Debian Buster theme wallpaper by using the Catppuccin color palette and are licensed under GPL-2.0+.

The config/git/ignore file was generated at gitignore.io and is licensed under CC0-1.0.