A simple Bash script to manage macOS configuration files using Git and symlinks.

• Overview
• Getting Started
  • First-Time Setup on Your Current Machine
  • Setup on a New Machine
• Daily Usage
• Manual Backup Approach
• Important Notes
• Troubleshooting
• Environment
• Neovim
• Lazygit
• TMUX

This script simplifies managing dotfiles (configuration files) by either:

• Symlink-based management: Run ./dotfiles install to create symlinks from your home directory to the Git repository, making the repository the source of truth. Changes to your configs are instantly reflected in the repository, enabling real-time version control.
• Manual backup: Run ./dotfiles backup to copy your configuration files to the repository for manual tracking without symlinks.

Run the script with one of these commands:

./dotfiles.sh install    # Set up symlinks for new machine
./dotfiles.sh backup     # Copy current configs to repository
./dotfiles.sh update     # Commit and push changes to Git
./dotfiles.sh help       # Show help message

To start managing your dotfiles with this repository:

1. Copy existing configs to the repository:

   ./dotfiles.sh backup

2. Commit the configs:

   git add .
   git commit -m "Initial dotfiles backup"
   git push

3. Switch to symlink-based management:

   ./dotfiles.sh install

This creates symlinks from your home directory to the repository, making it the source of truth.

To set up dotfiles on a new machine:

1. Install dotfiles before launching applications:

   ./dotfiles.sh install

2. Install your applications (e.g., Neovim, tmux, Kitty). They will automatically use the symlinked configurations.

With symlink-based management, edit your configs as usual:

nvim ~/.config/nvim/init.lua  # Edits the file in the repository

To save changes to the repository:

./dotfiles.sh update  # Quick commit and push
# OR
git add .
git commit -m "Detailed commit message"
git push

If you prefer not to use symlinks, you can manually back up your configs:

1. Keep your configuration files in their default locations (e.g., ~/.zshrc).

2. Run the backup command whenever you want to save changes:

   ./dotfiles.sh backup

3. Commit and push the changes:

   git add .
   git commit -m "Updated configs"
   git push

Note: This approach requires manual backups and does not provide real-time version tracking.

• Run install before launching applications on a new machine to ensure symlinks are in place.
• Use backup only once during initial setup if using symlinks. After install, edits happen directly in the repository.
• Repository as source of truth: With symlinks, your repository files are directly used by applications.
• Backup safety: Existing files are backed up to ~/.dotfiles_backup_<timestamp> during install if they are not already symlinks.

• Symlink errors: Ensure you have write permissions in ~/.config and other target directories. Check for existing files or symlinks that may conflict.
• Missing dotfiles: If a dotfile (e.g., ~/.zshrc) is not found during backup, ensure it exists in your home directory.
• Git issues: Verify your repository is properly initialized (git init) and configured with a remote (git remote add origin <url>).
• Application config not updating: Confirm symlinks are correctly set up by running ls -l in ~/.config or ~ to verify links point to the repository.

Install Kitty terminal:

curl -L https://sw.kovidgoyal.net/kitty/installer.sh | sh /dev/stdin

Install Nerd Fonts:

brew install --cask font-jetbrains-mono-nerd-font

Install Neovim:

brew install neovim

Install lazygit:

brew install lazygit

Install tree-sitter-cli:

brew install tree-sitter-cli

Install ripgrep (used for live grep):

brew install ripgrep

Install fd (used by Telescope for find):

brew install fd

Install fzf (used for fuzzy finder by Telescope):

brew install fzf

Install wget:

brew install wget

Configuration for Neovim, Vim-based text editor.

• Neovim
  • Quick Reference
  • Command Index
• LazyVim
  • News
  • Keymaps

Neovim key mapping, based on macOS.

Leader key: Spacebar

Configuration for TMUX, terminal multiplexer.

TMUX key mapping, based on macOS.

Prefix: <CONTROL-b>