Yet Another Dotfiles Manager
yadm - Yet Another Dotfiles Manager
[![Latest Version][releases-badge]][releases-link] [![Homebrew Version][homebrew-badge]][homebrew-link] [![OBS Version][obs-badge]][obs-link] [![Arch Version][arch-badge]][arch-link] [![License][license-badge]][license-link]
[![Master Update][master-date]][master-commits] [![Develop Update][develop-date]][develop-commits] [![Website Update][website-date]][website-commits]
[![Master Status][master-badge]][workflow-master] [![Develop Status][develop-badge]][workflow-develop] [![GH Pages Status][gh-pages-badge]][workflow-gh-pages] [![Dev Pages Status][dev-pages-badge]][workflow-dev-pages]
[https://yadm.io/][website-link]
yadm is a tool for managing [dotfiles][].
- Based on [Git][], with full range of Git's features
- Supports system-specific [alternative][feature-alternates] files or
- [Encryption][feature-encryption] of private data using [GnuPG][],
- Customizable initialization ([bootstrapping][feature-bootstrap])
- Customizable [hooks][feature-hooks] for before and after any operation
A very quick tour
# Initialize a new repository yadm init
# Clone an existing repository yadm clone
# Add files/changes yadm add
# Encrypt your ssh key echo '.ssh/id_rsa' > ~/.config/yadm/encrypt yadm encrypt
# Later, decrypt your ssh key yadm decrypt
# Create different files for Linux vs MacOS yadm add path/file.cfg##os.Linux yadm add path/file.cfg##os.Darwin
If you enjoy using yadm, consider adding a star to the repository on GitHub. The star count helps others discover yadm.
[Git]: https://git-scm.com/ [GnuPG]: https://gnupg.org/ [OpenSSL]: https://www.openssl.org/ [arch-badge]: https://img.shields.io/archlinux/v/extra/any/yadm [arch-link]: https://archlinux.org/packages/extra/any/yadm/ [dev-pages-badge]: https://img.shields.io/github/actions/workflow/status/yadm-dev/yadm/test.yml?branch=dev-pages [develop-badge]: https://img.shields.io/github/actions/workflow/status/yadm-dev/yadm/test.yml?branch=develop [develop-commits]: https://github.com/yadm-dev/yadm/commits/develop [develop-date]: https://img.shields.io/github/last-commit/yadm-dev/yadm/develop.svg?label=develop [dotfiles]: https://en.wikipedia.org/wiki/Hiddenfileandhiddendirectory [feature-alternates]: https://yadm.io/docs/alternates [feature-bootstrap]: https://yadm.io/docs/bootstrap [feature-hooks]: https://yadm.io/docs/hooks [feature-encryption]: https://yadm.io/docs/encryption [feature-templates]: https://yadm.io/docs/templates [gh-pages-badge]: https://img.shields.io/github/actions/workflow/status/yadm-dev/yadm/test.yml?branch=gh-pages [git-crypt]: https://github.com/AGWA/git-crypt [homebrew-badge]: https://img.shields.io/homebrew/v/yadm.svg [homebrew-link]: https://formulae.brew.sh/formula/yadm [license-badge]: https://img.shields.io/github/license/yadm-dev/yadm.svg [license-link]: https://github.com/yadm-dev/yadm/blob/master/LICENSE [master-badge]: https://img.shields.io/github/actions/workflow/status/yadm-dev/yadm/test.yml?branch=master [master-commits]: https://github.com/yadm-dev/yadm/commits/master [master-date]: https://img.shields.io/github/last-commit/yadm-dev/yadm/master.svg?label=master [obs-badge]: https://img.shields.io/badge/OBS-v3.5.0-blue [obs-link]: https://software.opensuse.org/download.html?project=home%3ATheLocehiliosan%3Ayadm&package=yadm [releases-badge]: https://img.shields.io/github/tag/yadm-dev/yadm.svg?label=latest+release [releases-link]: https://github.com/yadm-dev/yadm/releases [transcrypt]: https://github.com/elasticdog/transcrypt [website-commits]: https://github.com/yadm-dev/yadm/commits/gh-pages [website-date]: https://img.shields.io/github/last-commit/yadm-dev/yadm/gh-pages.svg?label=website [website-link]: https://yadm.io/ [workflow-dev-pages]: https://github.com/yadm-dev/yadm/actions?query=workflow%3a%22test+site%22+branch%3adev-pages [workflow-develop]: https://github.com/yadm-dev/yadm/actions?query=workflow%3ATests+branch%3Adevelop [workflow-gh-pages]: https://github.com/yadm-dev/yadm/actions?query=workflow%3a%22test+site%22+branch%3agh-pages [workflow-master]: https://github.com/yadm-dev/yadm/actions?query=workflow%3ATests+branch%3Amaster