Well, yes, but hear me out: This project was driven by the personal need of having to manage several dotfiles for different machines/targets. You want the same experience everywhere: On your Windows workstation along with an Ubuntu WSL instance, your Debian server and your private Arch installation. This tool fixes that problem while being cross-platform and blazingly fast. You won't need multiple sets of dotfile configurations ever again!
Features:
- Compile and deploy your dotfiles with one command across different platforms
- Use handlebar-like instructions to insert variables and compile sections conditionally
- Define pre- and post-hooks to customize the behavior with your own commands
- Create multiple profiles for different targets
- Works on Windows and Linux
Install punktf using Homebrew on Linux:
brew install michidk/tools/punktf
Install punktf from AUR on Arch Linux.
To install it use your favorite AUR capable package manager (e.g. yay, pikaur):
NOTE: As this builds punktf
from source an up-to-date rust installation aswell as the nightly toolchain are needed.
yay punktf
or
pikaur -S punktf
Install punktf using Chocolatey on Windows:
choco install punktf
To install punktf
from source the following is needed:
- An up-to-date rust installation
- An installed nightly toolchain
# Clone
git clone https://github.com/Shemnei/punktf
cd punktf
# Build (cargo)
cargo +nightly build --release
To deploy a profile, use the deploy
subcommand:
# deploy 'windows' profile
punktf deploy windows
# deploy (custom source folder)
punktf --source /home/demo/mydotfiles deploy windows
Adding the -h
/--help
flag to a given subcommand, will print usage instructions.
The punktf source folder, is the folder containing the dotfiles and punktf profiles. We recommend setting the PUNKTF_SOURCE
environment variable, so that the dotfiles can be compiled using punktf deploy <profile>
.
punktf searches for the source folder in the following order:
- CLI argument given with
-s
/--source
- Environment variable
PUNKTF_SOURCE
- Current working directory of the shell
The source folder should contain two sub-folders:
profiles\
: Contains the punktf profile definitions (.yaml
or.json
)dotfiles\
: Contains folders and the actual dotfiles
Example punktf source folder structure:
+ profiles
+ windows.yaml
+ base.yaml
+ arch.json
+ dotfiles
+ .gitconfig
+ init.vim.win
+ base
+ demo.txt
+ linux
+ .bashrc
+ windows
+ alacritty.yml
Determines where punktf
will deploy files too.
It can be set with:
- Variable
target
in the punktf profile file - Environment variable
PUNKTF_TARGET
Profiles define which dotfiles should be used. They can be a .json
or .yaml
file.
Example punktf profile:
variables:
OS: "windows"
target: "C:\\Users\\Demo"
dotfiles:
- path: "base"
- path: "windows/alacritty.yml"
target:
Path: "C:\\Users\\Demo\\AppData\\Local\\alacritty.yml"
merge: Ask
All properties are explained in the wiki.
Please refer to the wiki for the templating syntax.