INSTALLATION.md

Installation Guide

First Time Setup

1. Clone your dotfiles repository:

   git clone <your-repo-url> ~/code/dotfiles
   cd ~/code/dotfiles

2. Run the installation script:

   ./scripts/bin/dotfiles-install

   This will:

   • Create ~/.dotfiles symlink pointing to your dotfiles directory
   • Symlink ~/.zshrc to your dotfiles .zshrc
   • Symlink ~/.gitconfig to your git configuration
   • Make scripts in scripts/bin/ executable
   • Backup any existing files to ~/.dotfiles-backup-<timestamp>/

3. Restart your terminal or reload configuration:

   source ~/.zshrc

4. Install Homebrew packages (optional):

   brew bundle --file=~/.dotfiles/brew/.Brewfile

Adding to Your zshrc

If you want to manually load the dotfiles instead of using the install script, add this to your ~/.zshrc:

# Load dotfiles
if [ -f ~/.dotfiles/.zshrc ]; then
  source ~/.dotfiles/.zshrc
fi

Local Customization

Create ~/.zshrc.local for machine-specific settings:

# Copy the example file
cp ~/.dotfiles/.zshrc.local.example ~/.zshrc.local

# Edit with your local settings
$EDITOR ~/.zshrc.local

This file is not version controlled and will be loaded automatically.

What Gets Installed

After running the install script, your home directory will have:

• ~/.zshrc → symlink to ~/.dotfiles/.zshrc
• ~/.gitconfig → symlink to ~/.dotfiles/git/.gitconfig
• ~/.dotfiles → symlink to your dotfiles directory

Directory Structure Created

~/.dotfiles/
├── .zshrc              # Main zsh config
├── zsh/                # Modular zsh files
├── git/                # Git configuration
├── brew/               # Homebrew packages
├── ai/                 # AI workflows
└── scripts/bin/        # Utility scripts

Updating

To update your dotfiles:

cd ~/.dotfiles
git pull
source ~/.zshrc

Uninstalling

To remove the dotfiles:

# Remove symlinks
rm ~/.zshrc ~/.gitconfig ~/.dotfiles

# Restore backups if needed
# Backup files are in ~/.dotfiles-backup-<timestamp>/