Explore the docs »
·
Report Bug
·
Request Feature
Table of Contents
Tuckr is a dotfile manager inspired by Stow and Git. Tuckr aims to make dotfile management less painful. It follows the same model as Stow, symlinking files onto $HOME. It works on all the major OSes (Linux, Windows, BSDs and MacOS).
Tuckr aims to bring the simplicity of Stow to a dotfile manager with a very small learning curve. To achieve that goal Tuckr tries to only cover what is directly needed to manage dotfiles and nothing else. We won't wrap git, rm, cp or reimplement the functionality that are perfeclty covered by other utilities in the system unless it greatly impacts usability.
- No configuration
- Commands can be run from anywhere
- Symlinks are tracked and validated
- All configuration grouped and handled as a logical unit
- Provide hooks, optionally write configuration scripts for each group
- Easily encrypt and deploy sensitive configuration files
The following paths should be used for your dotfiles:
Dotfile Path in each OS:
| Platform | Config Path | Home Path |
|---|---|---|
| Linux/BSDs/etc | $HOME/.config/dotfiles | $HOME/.dotfiles |
| MacOS | $HOME/Library/Application Support/dotfiles | $HOME/.dotfiles |
| Windows | %HomePath%\AppData\Roaming/dotfiles | %HomePath%/.dotfiles |
To learn how to set it up for your dotfiles, check the How it works sections.
Tuckr is interchangeable with Stow. To migrate:
- Go to your dotfiles directory remove all symlinks with
stow -t $HOME --delete *
- Convert your repo:
tuckr from-stow
- Move your repo to
$HOME/.dotfilesor$HOME/.config/dotfiles - Resymlink your dotfiles with:
tuckr add \*
- Confirm that there were no conflicts with:
tuckr status
You need to enable developer mode for symlinking to work, this is a restriction imposed by the OS.
Install from source:
cargo install --git https://github.com/RaphGL/Tuckr.gitNote: The binary will be installed to $HOME/.cargo/bin either move it to somewhere in your $PATH or add it to path.
Install from the AUR:
paru -S tuckr-git$ tuckr add \* # adds all dotfiles to the system
$ tuckr add \* -e neovim # adds all dotfiles except neovim
$ tuckr add neovim zsh # adds the neovim and zsh dotfiles only
$ tuckr set \* # adds all the dotfiles and runs their hooks (scripts)
$ tuckr rm \* # removes all dotfiles from your systemUsage: tuckr <COMMAND>
Commands:
status Get dotfiles' symlinking status (alias: s)
add Deploy dotfiles for the supplied groups (alias: a)
rm Remove dotfiles for the supplied groups
set Setup groups and run their hooks
encrypt Encrypt files and move them to dotfiles/Secrets (alias: e)
decrypt Decrypt files (alias: d)
ls-hooks List available hooks
ls-secrets List stored secrets
init Initialize dotfile directory
from-stow Convert a GNU Stow repo into Tuckr
help Print this message or the help of the given subcommand(s)
Options:
-h, --help Print help
-V, --version Print version
Tuckr works with no configuration, this is achieved by making some assumptions about the structure of your dotfiles directory. Every Tuckr dotfiles directory should have the following structure:
dotfiles
├── Configs # Dotfiles go here
├── Secrets # Encrypted files go here
└── Hooks # Setup scripts go hereThese directories contain directories that separate the dotfiles by program name (or whatever you want to separate them by)
dotfiles
├── Configs
│ ├── tmux
│ └── zsh
└── Hooks
├── tmux
└── zshInside of these program directories the structure is exactly the same as what your $HOME looks like.
Configs
├── tmux
│ └── .config
│ └── tmux
│ └── tmux.conf
└── zsh
├── .zshenv
└── .zshrcThe program directories' names are used to reference them in commands
Hooks are run before and after adding every program, if they're coupled with a program they should their directory should have the same name in Hooks as in Configs.
Hooks that run before symlinking the program are prefixed with pre, scripts that run afterwards are prefixed with post, as long as this is true you can name the file whatever you want.
Hooks
├── tmux
│ ├── post.sh
│ └── pre.sh
└── zsh
├── post.sh
└── pre.shTo run scripts for a program run tuckr set <program_name> or alternatively use a wildcard like so: tuckr set \* to run all hooks.
Encrypt a file and put it in <group_name>
tuckr encrypt <group_name> <file_name...>
This will create an appropriate file in the Secrets directory pointing to the path where it originally came from
Decrypt files from the groups <group_name...> and put them on their appropriate paths
tuckr decrypt <group_name...>
Conditional deployment is used when a dotfile should only be deployment on a specific platform. This is done by creating a separate group with the same name suffixed with the desired platform.
This group is entirely ignored on unsupported systems.
Example:
Configs
├── config
├── config_unix # deployed on any unix system
├── config_linux # linux only files
├── config_macos # macos only files
└── config_windows # windows only filesThe groups that are supported on the target system will be treated as being a part of the original config group. One only needs to reference it to have all of the valid ones included as well.
Any of the options available on Rust's target_family and target_os are valid targets.
For scripting purposes Tuckr has the following exit codes:
2Could not find Dotfiles directory3No Configs/Hooks/Secrets directory setup4No such file or directory exists5Encryption failed6Decryption failed
On success Tuckr returns whatever is he default success return code for the platform (0 on unix systems).
Distributed under GPLv3 License. See LICENSE for more information.