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
- Configuration files are grouped and handled as a logical unit
- Provide ability to run hooks (scripts) that facilitate deployment and uninstallation
- Easily encrypt and deploy sensitive configuration files (WIP: please do not secrets for production just yet)
Tuckr uses a dotfiles directory to store all your configs. Please check the table below to know where to put it according to your operating system.
You can choose either the config or the 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 up your dotfiles, check the How it works sections.
Tuckr is interchangeable with Stow. To migrate:
- Go to your dotfiles directory remove all symlinks with
- Move your dotfiles directory to one of the valid paths and move all your directories there:
- Resymlink your dotfiles with:
- You can confirm that your dotfiles have been deployed:
You need to enable developer mode for symlinking to work, this is a restriction imposed by the OS.
Install from source:
Install from crates.io:
Note: 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:
Note: for additional information also check the wiki
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:
These directories contain directories that separate the dotfiles by program name (or whatever criteria you want to group them by)
Inside of these group directories the structure is exactly the same as what your $HOME looks like.
The group directories' names are used to reference them on tuckr.
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.
To run scripts for a program run tuckr set <program_name> or alternatively use a wildcard like so: tuckr set \* to run all hooks.
Please not that secrets are still WIP and their security is really not guaranteed. So it's best to avoid it in production. If you want to deploy secrets with tuckr, then consider create a hook that deploys secrets for you using some of the reputable encryption tools out there like veracrypt, gpg, etc.
Encrypt a file and put it in <group_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
Conditional deployment is used when a dotfile should only be deployed on a specific platform. This is done by creating a separate group with the same name suffixed with the desired platform.
Conditional groups are entirely ignored on unsupported systems.
Example:
The 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.
You might want to dynamically decide where to deploy a dotfile, for example a program might allow changing where the dotfiles will be or you might want to choose the location on a per machine basis. Tuckr allows you to use environment variables to decide where to place things. Anything prefixed with a % is considered an environment variable.
For example:
The %PROGRAM_PATH will be expanded to whatever was in the environment variable. So if you had %PROGRAM_PATH/config.txt and the environment variable was set as /home/user/Documents, the Tuckr will attempt to symlink it to /home/user/Documents/config.txt.
Some dotfiles are stored in some directory that outside of your home directory, by default tuckr doesn't support those, but by using the ^ it tells tuckr that it should target the root. So say you wanted to manage your crontab settings with tuckr, you would need to somehow symlink /etc/crontab. The file structure to do that would be:
The ^etc/crontab would be expanded to /etc/crontab.
For scripting purposes Tuckr has the following exit codes:
- 2 Could not find Dotfiles directory
- 3 No Configs/Hooks/Secrets directory setup
- 4 No such file or directory exists
- 5 Encryption failed
- 6 Decryption failed
On success Tuckr returns whatever is the default success return code for the platform (0 on unix-like systems).
Distributed under GPLv3 License. See LICENSE for more information.