Tuckr

A super powered replacement for GNU Stow

Explore the docs »

· Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Installation
3. Usage
   • How it works
   • Using hooks
   • Using secrets
   • Conditional Deployment
   • Exit codes
4. License

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.

Goals:

• 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)

Getting Started

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.

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 up your dotfiles, check the How it works sections.

Stow users

Tuckr is interchangeable with Stow. To migrate:

1. Go to your dotfiles directory remove all symlinks with

stow -t $HOME --delete *

2. Move your dotfiles directory to one of the valid paths and move all your directories there:

$ mkdir -p <CONFIG_PATH>/Configs
$ mv -t <CONFIG_PATH> * 

3. Resymlink your dotfiles with:

tuckr add \*

4. You can confirm that your dotfiles have been deployed:

tuckr status

Windows users

You need to enable developer mode for symlinking to work, this is a restriction imposed by the OS.

Installation

Install from source:

cargo install --git https://github.com/RaphGL/Tuckr.git

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:

paru -S tuckr-git

Usage

$ tuckr add \* # adds all dotfiles to the system
$ tuckr add \* -e neovim # adds all dotfiles except neovim
$ tuckr add neovim zsh # adds only the neovim and zsh dotfiles
$ tuckr set \* # adds all the dotfiles and runs their hooks (scripts)
$ tuckr rm \* # removes all dotfiles from your system

Super powered GNU Stow replacement

Usage: tuckr [OPTIONS] <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
  unset    Remove groups and run their cleanup hooks
  encrypt  Encrypt files and move them to dotfiles/Secrets (alias: e)
  decrypt  Decrypt files (alias: d)
  push     Copy files into groups
  pop      Remove groups from dotfiles/Configs
  ls       List dotfiles hooks, secrets, profiles
  init     Initialize dotfile directory
  groupis  Return the group files belongs to
  help     Print this message or the help of the given subcommand(s)

Options:
  -p, --profile <PROFILE>  Choose which dotfile profile to use
  -h, --help               Print help
  -V, --version            Print version

Note: for additional information also check the wiki

How it works

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 here

These directories contain directories that separate the dotfiles by program name (or whatever criteria you want to group them by)

dotfiles
├── Configs
│   ├── tmux
│   └── zsh
└── Hooks
    ├── tmux
    └── zsh

Inside of these group directories the structure is exactly the same as what your $HOME looks like.

Configs
├── tmux
│   └── .config
│       └── tmux
│           └── tmux.conf
└── zsh
    ├── .zshenv
    └── .zshrc

The group directories' names are used to reference them on tuckr.

Using Hooks

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.sh

To run scripts for a program run tuckr set <program_name> or alternatively use a wildcard like so: tuckr set \* to run all hooks.

Using Secrets

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.

Encrypting files

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

Decrypting files

Decrypt files from the groups <group_name...> and put them on their appropriate paths

tuckr decrypt <group_name...>

Conditional deployment

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:

Configs
├── config
├── config_unix # deployed on any unix-like system
├── config_linux # linux only files
├── config_macos # macos only files
└── config_windows # windows only files

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.

Exit codes

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).

License

Distributed under GPLv3 License. See LICENSE for more information.