Yet Another Dotfiles Manager
Go to file
Tim Byrne dcfa55ce49
Update version number and update documentation
* Support encryption with OpenSSL (#138)
* Support "include" directive in built-in template processor (#255)
* Support extensions for alternate files and templates (#257)
* Improve support for default branches (#231, #232)
* Add --version and --help as yadm internal commands (#267)
* Improve support for XDG base directory specification
* Use XDG_DATA_HOME used for encrypted data and repository (#208)
* Default repo is now ~/.local/share/yadm/repo.git
* Default encrypted archive is now ~/.local/share/yadm/archive
* Improve shell completions (#238, #274, #275)
* Remove support for YADM_COMPATIBILITY=1 (#242)
* Remove deprecated option cygwin-copy
* Fix template mode inheritance on FreeBSD (#243, #246)
* Fix hook execution under MinGW (#150)
* Improve compatibility with Oil shell (#210)
2020-12-30 16:59:58 -06:00
.github Run "make test" in github workflow 2020-12-30 12:54:13 +01:00
completion zsh: -d can't be used as a global option 2020-12-29 21:30:00 +01:00
contrib/hooks Release 2.4.0 2020-02-06 07:53:18 -06:00
test Support upgrading from version 1 repos 2020-12-30 14:19:49 -06:00
.gitattributes Force `eol=lf` 2017-01-09 16:52:01 -06:00
.gitignore Use a common target to pick yadm to test in test/scripthost 2020-12-30 12:01:40 +01:00
CHANGES Update version number and update documentation 2020-12-30 16:59:58 -06:00
CONTRIBUTORS Update version number and update documentation 2020-12-30 16:59:58 -06:00
LICENSE Update GPLv3 LICENSE information 2019-03-14 18:25:02 -05:00
Makefile Use -E instead of -r 2020-12-30 14:46:04 -06:00
README.md Update version number and update documentation 2020-12-30 16:59:58 -06:00
bootstrap Standardize on &> when not appending output 2019-12-04 22:39:00 -06:00
pylintrc Move min-similarity-lines to new section 2019-10-02 15:16:10 -05:00
pytest.ini Mark deprecated tests 2019-10-02 15:16:09 -05:00
yadm Update version number and update documentation 2020-12-30 16:59:58 -06:00
yadm.1 Update version number and update documentation 2020-12-30 16:59:58 -06:00
yadm.md Update version number and update documentation 2020-12-30 16:59:58 -06:00
yadm.spec Update version number and update documentation 2020-12-30 16:59:58 -06:00

README.md

yadm - Yet Another Dotfiles Manager

Latest Version Homebrew Version OBS Version Arch Version License
Master Update Develop Update Website Update
Master Status Develop Status GH Pages Status Dev Pages Status

https://yadm.io/

yadm is a tool for managing dotfiles.

  • Based on Git, with full range of Git's features
  • Supports system-specific alternative files or templated files
  • Encryption of private data using GnuPG, OpenSSL, transcrypt, or git-crypt
  • Customizable initialization (bootstrapping)
  • Customizable hooks for before and after any operation

Complete features, usage, examples and installation instructions can be found on the yadm.io website.

A very quick tour

# Initialize a new repository
yadm init

# Clone an existing repository
yadm clone <url>

# Add files/changes
yadm add <important file>
yadm commit

# 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.