Introduction

Welcome to the fdf documentation.

What is fdf?

fdf (Fetch Dot Files) is a lightweight command-line utility for deploying dotfiles from a Git repository to your system.

Instead of manually copying files or writing shell scripts, you define where each file should go in a simple setup.fdf config, and fdf handles the rest.

Features

• Simple declarative syntax
• Backs up existing files automatically
• Supports directories
• Run post-install commands
• Dry-run mode to preview changes
• Works with any git host
• Easy rollback

Quick Example

# deploy someone's dotfiles
fdf -r https://github.com/someone/dotfiles

# or use your own local repo
fdf -l ~/my-dotfiles

The repo needs a setup.fdf file like:

"syn-cmd">PUT .bashrc "syn-kw">IN ~/.bashrc
"syn-cmd">PUT .config/nvim "syn-kw">IN ~/.config/nvim
"syn-end">END FETCH

Getting Started

1. Install fdf on your system
2. Learn about the configuration syntax
3. Check out examples for ideas
4. Try out the rollback tool.