Automate deployment of dotfiles to local paths or remote hosts
Project description
dotlink
Automate deployment of dotfiles to local paths or remote hosts
install
$ pipx install dotlink
usage
List your dotfiles in a simple text format named either .dotlink
or dotlink
:
# comments are lines starting with hash
# simple file listing
.vimrc
.zshrc
# map files to different names/paths (destination = source)
.config/htop/htoprc = htoprc
# include configs from submodules or other directories
@submodule/
See example repo/config at https://github.com/amyreese/dotfiles
Tell dotlink where your dotfile repo is, and where it should put things. Defaults to the current directory and your home directory, respectively:
$ dotlink [<source>] [<destination>]
Use --plan
to see what dotlink will do before doing it:
$ dotlink --plan [...]
The source can be a cloneable git repo:
$ dotlink https://github.com/amyreese/dotfiles.git
The destination can be a remote, ssh-able location:
$ dotlink <source> [<user>@]host:/path/to/destination
legal
dotlink is copyright Amethyst Reese.
dotlink is licensed under the MIT license.
See the LICENSE
file for more details.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.