#dotfiles #management #dotfile

bin+lib hm

homemaker. Slightly more than yet another dotfile manager.

27 releases

0.7.5 Nov 5, 2022
0.7.3 Sep 28, 2021
0.6.7 Jun 2, 2021
0.6.4 Mar 23, 2021
0.3.5 Nov 30, 2020

#88 in Filesystem

32 downloads per month

Apache-2.0

49KB
946 lines

Continuous integration

Have a dotfiles directory with all your stuff in it? Have homemaker put everything in its right place.

Check out the changelog

homemaker in action

hm in action

installation

  • from crates.io: cargo install hm
  • from github (may be in some state of flux): cargo install --git https://github.com/hlmtre/homemaker
  • cloned locally: cargo install --path .
  1. create a config.toml file either anywhere (and specify -c when you run hm) or in ~/.config/homemaker/.
  2. enter things to do things to in the file. example:
## config.toml

[[obj]]
file = 'tmux.conf' # simple things - symlink or copy a file somewhere
source = '~/dotfiles/.tmux.conf'
destination = '~/.tmux.conf'
method = 'symlink'

[[obj]]
task = 'zt' # more complicated - a task.
solution = 'cd ~/dotfiles/zt && git pull'
dependencies = ['maim, slop']
os = 'linux::debian'

[[obj]]
task = 'maim_dependencies'
solution = 'sudo apt install -y libxfixes-dev libglm-dev libxrandr-dev libglew-dev libegl1-mesa-dev libxcomposite-dev'
os = 'linux::debian' # only if the platform matches.
# valid OS values we differentiate between are:
# linux::fedora
# linux::debian
# linux::ubuntu
# windows

[[obj]]
task = 'maim'
source = '~/dotfiles/zt/maim'
solution = 'cd ~/dotfiles/zt/maim; make clean; cmake -DCMAKE_INSTALL_PREFIX="/usr" ./ && make && sudo make install'
method = 'execute'
dependencies = ['maim_dependencies']

[[obj]]
task = 'slop'
source = '~/dotfiles/zt/slop'
solution = 'cd ~/dotfiles/zt/slop; make clean; cmake -DCMAKE_INSTALL_PREFIX="/usr" ./ && make && sudo make install'
method = 'execute'
os = 'linux::debian'

[[obj]]
task = 'slop'
source = '~/dotfiles/zt/slop'
solution = 'cd ~/dotfiles/zt/slop; make clean; cmake -DCMAKE_INSTALL_PREFIX="/usr" ./ && make && sudo make install'
method = 'execute'
os = 'linux::debian'

[[obj]]
task = 'nvim'
method = 'execute'
solution = "test -x /usr/local/bin/nvim || (git clone https://github.com/neovim/nevim.git ~/src/ && cd ~/src/neovim && make CMAKE_BUILD_TYPE=RelWithDebInfo CMAKE_INSTALL_PREFIX=/usr/local/ && sudo make install)" # if nvim is not there and executable, run our solution.
dependencies = ['vim-plug']

[[obj]]
task = 'vim-plug'
method = 'execute'
solution = "sh -c 'curl -fLo ~/.local/share/nvim/site/autoload/plug.vim --create-dirs https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim'"
  1. hm -c /path/to/your/config.toml
  • simple file entries either symlink or copy a file somewhere - usually a config file.
  • tasks are more complicated actions to perform - run scripts, download/compile software, etc. they can be restricted to specific platforms (differentiated values are specified above in the maim_dependencies task).

why homemaker?

  • compared to say, gnu stow, homemaker supports more than just creating a mirrored symlinked filesystem.
  • dependency resolution:
    • specify a set of tasks to complete, each with their own dependencies, and watch as it completes them in some order that satisfies each task's dependencies.
    • for example, in the sample config.toml (the one i use, actually), maim depends on having some graphics libraries installed. i created a task called maim_dependencies, and hm will complete maim_dependencies before attempting to complete maim.
    • zt has two dependencies: maim and slop. hm will complete the entire dependency tree below zt before atttempting zt.
    • homemaker complains if the dependency tree cannot be solved, and shows you a hopefully-handy explanation why. dep graph
  • allows for specifying portions of the config to be executed (target tasks). only wanna run one task? -t <taskname>

subtree

homemaker unknowingly clobbers an existing dotfile manager written in Go some time ago. Linked here.

built with spacemacs and neovim.

Could not be made without rust-analyzer.

Dependencies

~3.5–5MB
~110K SLoC