donut

donut

Tiny dotfiles management tool written in Go.

Installation

Homebrew

brew install gleamsoda/tap/donut

source

go install github.com/gleamsoda/donut/cmd/donut@latest

Usage

1. Creating a configuration file.
   The configuration file will be created at $HOME/.config/donut/donut.toml.

donut init

1. Move your dotfiles to the directory managed by donut (default: $HOME/.local/share/donut).

git clone your/dotfiles.git ~/.local/share/donut

1. Check the list and changes of files managed by donut.

donut list  // displays the list of files
donut diff  // displays the changes between source and destination files

1. Handle the changes between source and destination files.

donut apply // apply the changes
donut merge // merge the changes with merge tool

Configuration

The configuration file can be placed in the following locations:

• $XDG_CONFIG_HOME
• $XDG_CONFIG_HOME/donut
• $HOME/.config
• $HOME/.config/donut

Configuration Options

• destination: The destination directory where the files will be applied. (default: "$HOME").
• source: The source directory containing the files that will be managed. (default: "$HOME/.local/share/donut").
• editor: The command or executable to be used as the text editor. (default: ["vim"]).
• pager: The command or executable to be used as the pager for viewing file differences. (default: ["less", "-R"])
• diff: The command or executable to be used for displaying differences between files. (default: ["diff", "-upN", "{{.Destination}}", "{{.Source}}"]).
• merge: The command or executable to be used for merging file changes. (default: ["vimdiff", "{{.Destination}}", "{{.Source}}"]).
• excludes: A list of files or directories to be excluded from management. (default: []).

You can modify these configuration options according to your needs in the configuration file. Ensure that the paths and commands are correctly set to match your system.