2019-03-14 09:22:44 -04:00
|
|
|
# yadm - Yet Another Dotfiles Manager
|
2015-07-16 20:45:34 -04:00
|
|
|
|
2019-03-14 09:22:44 -04:00
|
|
|
[![Latest Version][releases-badge]][releases-link]
|
|
|
|
|
[![Homebrew Version][homebrew-badge]][homebrew-link]
|
2019-11-08 08:18:02 -05:00
|
|
|
[![OBS Version][obs-badge]][obs-link]
|
2019-03-15 01:10:48 -04:00
|
|
|
[![Arch Version][aur-badge]][aur-link]
|
2019-03-14 09:22:44 -04:00
|
|
|
[![License][license-badge]][license-link]<br />
|
|
|
|
|
[![Master Update][master-date]][master-commits]
|
|
|
|
|
[![Develop Update][develop-date]][develop-commits]
|
|
|
|
|
[![Website Update][website-date]][website-commits]<br />
|
2020-11-22 17:39:37 -05:00
|
|
|
[![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]
|
2015-07-16 20:45:34 -04:00
|
|
|
|
2019-03-14 09:22:44 -04:00
|
|
|
[https://yadm.io/][website-link]
|
2015-07-21 09:46:53 -04:00
|
|
|
|
2020-12-27 22:43:47 -05:00
|
|
|
**yadm** is a tool for managing [dotfiles][].
|
2019-03-14 09:22:44 -04:00
|
|
|
|
|
|
|
|
* Based on [Git][], with full range of Git's features
|
2020-12-27 22:43:47 -05:00
|
|
|
* Supports system-specific alternative files or templated files
|
|
|
|
|
* Encryption of private data using [GnuPG][], [OpenSSL][], [transcrypt][], or
|
|
|
|
|
[git-crypt][]
|
2019-03-14 09:22:44 -04:00
|
|
|
* Customizable initialization (bootstrapping)
|
2020-12-27 22:43:47 -05:00
|
|
|
* Customizable hooks for before and after any operation
|
2019-03-14 09:22:44 -04:00
|
|
|
|
2020-12-27 22:43:47 -05:00
|
|
|
Complete features, usage, examples and installation instructions can be found on
|
|
|
|
|
the [yadm.io][website-link] 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.
|
2019-03-14 09:22:44 -04:00
|
|
|
|
|
|
|
|
[Git]: https://git-scm.com/
|
|
|
|
|
[GnuPG]: https://gnupg.org/
|
2020-12-27 22:43:47 -05:00
|
|
|
[OpenSSL]: https://www.openssl.org/
|
2020-12-30 15:58:30 -05:00
|
|
|
[aur-badge]: https://img.shields.io/aur/version/yadm.svg
|
|
|
|
|
[aur-link]: https://aur.archlinux.org/packages/yadm
|
2020-11-22 17:39:37 -05:00
|
|
|
[dev-pages-badge]: https://img.shields.io/github/workflow/status/TheLocehiliosan/yadm/Test%20Site/dev-pages?label=dev-pages
|
|
|
|
|
[develop-badge]: https://img.shields.io/github/workflow/status/TheLocehiliosan/yadm/Tests/develop?label=develop
|
2019-03-14 09:22:44 -04:00
|
|
|
[develop-commits]: https://github.com/TheLocehiliosan/yadm/commits/develop
|
|
|
|
|
[develop-date]: https://img.shields.io/github/last-commit/TheLocehiliosan/yadm/develop.svg?label=develop
|
|
|
|
|
[dotfiles]: https://en.wikipedia.org/wiki/Hidden_file_and_hidden_directory
|
2020-11-22 17:39:37 -05:00
|
|
|
[gh-pages-badge]: https://img.shields.io/github/workflow/status/TheLocehiliosan/yadm/Test%20Site/gh-pages?label=gh-pages
|
2020-12-27 22:43:47 -05:00
|
|
|
[git-crypt]: https://github.com/AGWA/git-crypt
|
2019-03-14 09:22:44 -04:00
|
|
|
[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/TheLocehiliosan/yadm.svg
|
|
|
|
|
[license-link]: https://github.com/TheLocehiliosan/yadm/blob/master/LICENSE
|
2020-11-22 17:39:37 -05:00
|
|
|
[master-badge]: https://img.shields.io/github/workflow/status/TheLocehiliosan/yadm/Tests/master?label=master
|
2019-03-14 09:22:44 -04:00
|
|
|
[master-commits]: https://github.com/TheLocehiliosan/yadm/commits/master
|
|
|
|
|
[master-date]: https://img.shields.io/github/last-commit/TheLocehiliosan/yadm/master.svg?label=master
|
2020-12-30 15:58:30 -05:00
|
|
|
[obs-badge]: https://img.shields.io/badge/OBS-v3.0.0-blue
|
2019-11-08 08:18:02 -05:00
|
|
|
[obs-link]: https://software.opensuse.org//download.html?project=home%3ATheLocehiliosan%3Ayadm&package=yadm
|
2019-03-14 09:22:44 -04:00
|
|
|
[releases-badge]: https://img.shields.io/github/tag/TheLocehiliosan/yadm.svg?label=latest+release
|
|
|
|
|
[releases-link]: https://github.com/TheLocehiliosan/yadm/releases
|
2020-12-27 22:43:47 -05:00
|
|
|
[transcrypt]: https://github.com/elasticdog/transcrypt
|
2020-06-15 16:29:19 -04:00
|
|
|
[travis-ci]: https://travis-ci.com/TheLocehiliosan/yadm/branches
|
2019-03-14 09:22:44 -04:00
|
|
|
[website-commits]: https://github.com/TheLocehiliosan/yadm/commits/gh-pages
|
|
|
|
|
[website-date]: https://img.shields.io/github/last-commit/TheLocehiliosan/yadm/gh-pages.svg?label=website
|
|
|
|
|
[website-link]: https://yadm.io/
|
2020-11-22 17:39:37 -05:00
|
|
|
[workflow-dev-pages]: https://github.com/thelocehiliosan/yadm/actions?query=workflow%3a%22test+site%22+branch%3adev-pages
|
|
|
|
|
[workflow-develop]: https://github.com/TheLocehiliosan/yadm/actions?query=workflow%3ATests+branch%3Adevelop
|
|
|
|
|
[workflow-gh-pages]: https://github.com/thelocehiliosan/yadm/actions?query=workflow%3a%22test+site%22+branch%3agh-pages
|
|
|
|
|
[workflow-master]: https://github.com/TheLocehiliosan/yadm/actions?query=workflow%3ATests+branch%3Amaster
|
