https://github.com/amyreese/dotlink

Python script to automate deployment of dotfile from git repos to local and remote hosts
https://github.com/amyreese/dotlink

dotfile-management dotfile-manager dotfiles python

Last synced: 5 days ago
JSON representation

Python script to automate deployment of dotfile from git repos to local and remote hosts

• Host: GitHub
• URL: https://github.com/amyreese/dotlink
• Owner: amyreese
• License: mit
• Created: 2013-09-01T01:04:15.000Z (over 11 years ago)
• Default Branch: main
• Last Pushed: 2024-08-01T03:32:14.000Z (6 months ago)
• Last Synced: 2025-01-02T02:11:50.425Z (22 days ago)
• Topics: dotfile-management, dotfile-manager, dotfiles, python
• Language: Python
• Size: 90.8 KB
• Stars: 16
• Watchers: 4
• Forks: 2
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
dotlink

=======

Automate deployment of dotfiles to local paths or remote hosts

[![version](https://img.shields.io/pypi/v/dotlink.svg)](https://pypi.org/project/dotlink)

[![changelog](https://img.shields.io/badge/change-log-blue)](https://github.com/amyreese/dotlink/blob/main/CHANGELOG.md)

[![license](https://img.shields.io/pypi/l/dotlink.svg)](https://github.com/amyreese/dotlink/blob/main/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 [] []

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  [@]host:/path/to/destination

legal

-----

dotlink is copyright [Amethyst Reese](https://noswap.com).

dotlink is licensed under the MIT license.

See the `LICENSE` file for more details.