Skip to main content

dotlink

Automate deployment of dotfiles to local paths or remote hosts

version changelog license

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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dotlink-2.1.tar.gz (14.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

dotlink-2.1-py3-none-any.whl (14.0 kB view details)

Uploaded Python 3

Release history Release notifications | RSS feed

This release

2.1 This release

2 files

2.0

2 files

1.0.post0

2 files

1.0

2 files

0.6.0

1 file

0.5.0

1 file

0.4.3

1 file

0.4.2

1 file

0.4.1

1 file

0.4.0

1 file

0.3.1

1 file

0.3.0

1 file

0.2.0

1 file

0.1.1

1 file

0.1.0

1 file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page