How kabero/dotfiles works
Project type and purpose
• This is a “dotfiles” repository: a personal configuration management project.
• It uses chezmoi plus Git to store and deploy shell configs, editor settings, terminal themes, etc., across machines.
File structure
• Top-level files:
• .chezmoiignore & .gitignore – define what to skip in deployment and versioning
• README.md – overview of included tools and setup hints
• dot_* directories – each holds a set of config files named for the target path in your home directory
• excludes/ – scripts and files you want in the repo but not managed by chezmoi
• Key patterns:
• “dot_config” holds sub-directories for alacritty, bat, git, nvim, starship, etc.
• “dot_zsh”, “dot_vimrc”, “dot_tmux.conf” are single-file configs.
• chezmoi treats each “dot_…” entry as a source and symlinks or templates it into ~/.config or ~/.*.
README for additional insights
• Lists major tools: alacritty, asdf, git, neovim, starship, tmux, vim, zsh, chezmoi, obsidian
• Mentions helper tools: fzf, navi, pet
• Provides alias examples and fzf keybindings
a. Main components
• Version Control: Git repo (local + remote origin)
• Deployment Engine: chezmoi CLI
• File System: user’s $HOME (with ~/.config and ~/.*)
• Runtime Consumers: alacritty, neovim, tmux, zsh, starship, obsidian, etc.
b. Relationships & interactions
1. Git repo is cloned or pulled → local copy
2. chezmoi reads repo, .chezmoiignore, templates → writes/symlinks into $HOME
3. When user launches an app (e.g., alacritty), the app reads its config from ~/.config/alacritty/…
c. Architectural patterns
• Infrastructure-as-Code: declarative dotfiles
• Idempotent deployment: running “chezmoi apply” yields consistent environment
• Separation of concerns:
– Source (repo) vs. Deployed files (home directory)
– Excluded files remain in /excludes but are never linked
d. Key technologies
• Git / GitHub (versioning & collaboration)
• chezmoi (dotfiles management)
• Deno (used by some scripts, e.g., bufpreview.vim)
• Shell apps: zsh + completions, fzf, navi, pet
• Editors & terminals: neovim, vim, alacritty, tmux, obsidian
Detail is key
• Break out each top-level “dot_*” directory as a sub-component under “chezmoi”
• .chezmoiignore excluding “excludes/”
• That running chezmoi apply is the central orchestration step