This guide will help you get up and running with go4dot, whether you're setting up a new machine or creating a new dotfiles repository.
If you already have a dotfiles repository configured with go4dot:
-
Clone your repository:
git clone https://github.com/yourusername/dotfiles.git ~/dotfiles cd ~/dotfiles
-
Install go4dot: (If you haven't already, see Installation)
curl -fsSL https://raw.githubusercontent.com/nvandessel/go4dot/main/scripts/install.sh | bash -
Run the install command:
g4d install
The interactive wizard will guide you through:
- Installing system dependencies (git, zsh, neovim, etc.)
- Configuring machine-specific settings (git user/email, GPG keys)
- Selecting which configs to stow (e.g. core vs optional)
- Cloning external dependencies (plugins, themes)
If you have existing dotfiles but haven't used go4dot before:
-
Navigate to your dotfiles directory:
cd ~/path/to/your/dotfiles
-
Initialize configuration:
g4d init
go4dot will scan your directory for common config folders (nvim, git, zsh, tmux, etc.) and generate a
.go4dot.yamlfile. -
Customize your config: Edit
.go4dot.yamlto fine-tune your setup. See Configuration Reference for details. -
Test your setup:
g4d install
Run g4d doctor at any time to verify your installation. It checks for:
- Missing system dependencies
- Broken symlinks
- Misconfigured external dependencies
- Valid machine configuration
g4d doctorTo pull the latest changes from your dotfiles repo and apply them:
g4d updateThis will:
git pullin your dotfiles directory- Detect new configs or changes
- Re-run
stowto ensure symlinks are correct - Update external dependencies (plugins, themes)
-
List installed configs:
g4d list
-
Reconfigure machine settings: (Useful if you want to change your git email or GPG key)
g4d reconfigure
-
Uninstall: (Removes symlinks, keeps the files)
g4d uninstall