Sweet Pastry .dotfiles

Below is an example demonstrating how to use GNU Stow to manage your .dotfiles. For more detailed information, please refer to the official documentation.

Installation

macOS (via Homebrew)

brew install stow

Creating a .dotfiles Folder

mkdir ~/.dotfiles

Place all configuration files you want to manage (e.g., for Neovim, Zsh, Git, etc.) in this folder for centralized version control and easy maintenance.

Example: Managing Neovim Configuration

1. Create the configuration directory (in the example, serves as the “package” name):

mkdir -p ~/.dotfiles/<Username>/.config/nvim

2. Add your Neovim config files (e.g., init.vim or init.lua) to the ~/.dotfiles/<Username>/.config/nvim folder.
3. Run stow from within your ~/.dotfiles directory to create symbolic links:

cd ~/.dotfiles
stow <Username>

This will automatically link all files in the <Username> folder to your $HOME directory following the same file structure. It is similar to using ln -s, but stow handles more complex symlink structures for you.

By using this approach, you can keep your configuration files neatly organized, version-controlled, and easily portable across different environments.

--adopt option

You may encounter some problems like

(base) ~/.dotfiles (main ✗) stow vim
WARNING! stowing vim would cause conflicts:
* cannot stow .dotfiles/vim/.vimrc over existing target .vimrc since neither a link nor a directory and --adopt not specified
All operations aborted.

This issue occurs because your local configuration file (in this case, ~/.vimrc) already exists and is not a symbolic link managed by stow. To resolve this, you can use the following command:

stow -v --adopt vim

The --adopt option has two effects:

1. It moves the existing ~/.vimrc file to your ~/.dotfiles directory.
2. It creates a symbolic link for ~/.vimrc pointing to ~/.dotfiles/vim/.vimrc.

This is generally safe, as it preserves your existing file and allows stow to manage it going forward.