2016-09-07 03:19:16 +00:00
|
|
|
---
|
|
|
|
layout: splash
|
|
|
|
permalink: /
|
|
|
|
stars_button: '
|
|
|
|
{::nomarkdown}<iframe
|
|
|
|
src="https://ghbtns.com/github-btn.html?user=TheLocehiliosan&repo=yadm&type=star&count=true"
|
|
|
|
frameborder="0" scrolling="0" width="100"
|
|
|
|
height="20px" style="float: right;"></iframe>{:/nomarkdown}
|
|
|
|
'
|
2019-03-20 05:53:14 +00:00
|
|
|
title: Yet Another Dotfiles Manager
|
2016-09-07 03:19:16 +00:00
|
|
|
header:
|
|
|
|
overlay_color: "#000"
|
|
|
|
overlay_filter: 0.7
|
2019-03-20 05:53:14 +00:00
|
|
|
overlay_image: /images/unsplash.jpg
|
|
|
|
cta_label: Install Now
|
|
|
|
cta_url: /docs/install
|
|
|
|
caption: "_Photo: [Michael Jasmund](https://unsplash.com/photos/o51enAB_89A)_"
|
2016-09-07 03:19:16 +00:00
|
|
|
excerpt: '
|
|
|
|
|
|
|
|
When you live in a command line, configurations are a deeply personal thing.
|
|
|
|
They are often crafted over years of experience, battles lost, lessons learned,
|
|
|
|
advice followed, and ingenuity rewarded. When you are away from your own
|
|
|
|
configurations, you are an orphaned refugee in unfamiliar and hostile
|
|
|
|
surroundings. You feel clumsy and out of sorts. You are filled with a sense of
|
|
|
|
longing to be back in a place you know. A place you built. A place where all the
|
|
|
|
short-cuts have been worn bare by your own travels. A place you proudly call...
|
|
|
|
**$HOME**.
|
|
|
|
|
|
|
|
'
|
|
|
|
feature_row:
|
2019-03-20 05:53:14 +00:00
|
|
|
- title: Overview
|
|
|
|
alt: Overview
|
|
|
|
btn_class: btn--inverse
|
|
|
|
btn_label: Discover yadm
|
2019-10-20 20:07:13 +00:00
|
|
|
image_path: /images/picture-padding.png
|
2019-03-20 05:53:14 +00:00
|
|
|
url: /docs/overview
|
2016-09-07 03:19:16 +00:00
|
|
|
excerpt: '
|
|
|
|
|
2019-10-19 18:59:03 +00:00
|
|
|
If you know how to use Git, you already know how to use yadm.
|
|
|
|
yadm helps you maintain a single repository of dotfiles, while keeping
|
2016-09-07 03:19:16 +00:00
|
|
|
them where they belong---in `$HOME`.
|
2019-10-19 18:59:03 +00:00
|
|
|
Anything you can do with Git, you can do using yadm.
|
2016-09-07 03:19:16 +00:00
|
|
|
|
|
|
|
'
|
2019-03-20 05:53:14 +00:00
|
|
|
- title: Alternate Files
|
|
|
|
alt: Alternates
|
|
|
|
btn_class: btn--inverse
|
|
|
|
btn_label: Details
|
|
|
|
image_path: /images/copy-padding.png
|
|
|
|
url: /docs/alternates
|
2016-09-07 03:19:16 +00:00
|
|
|
excerpt: '
|
|
|
|
|
|
|
|
Sometimes you need different configurations on different systems.
|
2019-10-19 18:59:03 +00:00
|
|
|
yadm makes it possible to use alternate versions of files based on
|
2016-09-07 03:19:16 +00:00
|
|
|
the OS or hostname of the system.
|
2019-10-20 20:07:13 +00:00
|
|
|
Templates allow you to use alternate sections within files.
|
2016-09-07 03:19:16 +00:00
|
|
|
|
|
|
|
'
|
2019-03-20 05:53:14 +00:00
|
|
|
- title: Encryption
|
|
|
|
alt: Encryption
|
|
|
|
btn_class: btn--inverse
|
|
|
|
btn_label: Learn more
|
|
|
|
image_path: /images/secret-padding.png
|
|
|
|
url: /docs/encryption
|
2016-09-07 03:19:16 +00:00
|
|
|
excerpt: '
|
|
|
|
|
|
|
|
Configurations occasionally include secrets such as passwords,
|
2019-10-19 18:59:03 +00:00
|
|
|
encryption keys, or other sensitive information. yadm allows you to
|
2016-09-07 03:19:16 +00:00
|
|
|
add such files to an encrypted archive, which can be maintained
|
|
|
|
alongside your other configurations.
|
|
|
|
|
2017-02-05 22:39:31 +00:00
|
|
|
'
|
2019-03-20 05:53:14 +00:00
|
|
|
- title: Bootstrap
|
|
|
|
alt: Bootstrap
|
|
|
|
btn_class: btn--inverse
|
|
|
|
btn_label: Explore how
|
|
|
|
image_path: /images/tasks-padding.png
|
|
|
|
url: /docs/bootstrap
|
2017-02-05 22:39:31 +00:00
|
|
|
excerpt: '
|
|
|
|
|
|
|
|
Define your own instructions to complete your dotfiles installation.
|
2019-10-19 18:59:03 +00:00
|
|
|
If provided, yadm can execute your custom program immediately
|
2017-02-05 22:39:31 +00:00
|
|
|
following a successful clone.
|
|
|
|
|
2019-10-20 20:07:13 +00:00
|
|
|
'
|
|
|
|
- title: Hooks
|
|
|
|
alt: Hooks
|
|
|
|
btn_class: btn--inverse
|
|
|
|
btn_label: Get started
|
|
|
|
image_path: /images/cogs-padding.png
|
|
|
|
url: /docs/hooks
|
|
|
|
excerpt: '
|
|
|
|
|
|
|
|
Perform custom operations before or after any yadm command.
|
|
|
|
|
2016-09-07 03:19:16 +00:00
|
|
|
'
|
2019-03-20 05:53:14 +00:00
|
|
|
- title: FAQ
|
|
|
|
alt: FAQ
|
|
|
|
btn_class: btn--inverse
|
|
|
|
btn_label: Get answers
|
|
|
|
image_path: /images/question-circle-padding.png
|
|
|
|
url: /docs/faq
|
2016-09-07 03:19:16 +00:00
|
|
|
excerpt: '
|
|
|
|
|
|
|
|
Have a question? You might find an answer in the FAQ.
|
|
|
|
|
|
|
|
'
|
2019-03-20 05:53:14 +00:00
|
|
|
- title: Manual
|
|
|
|
alt: Manual
|
|
|
|
btn_class: btn--inverse
|
|
|
|
btn_label: See man page
|
|
|
|
image_path: /images/book-padding.png
|
|
|
|
url: https://github.com/TheLocehiliosan/yadm/blob/master/yadm.md
|
2016-09-07 03:19:16 +00:00
|
|
|
excerpt: '
|
|
|
|
|
|
|
|
View the manual online.
|
|
|
|
|
|
|
|
'
|
2019-03-20 05:53:14 +00:00
|
|
|
- title: Example Dotfiles
|
|
|
|
alt: Examples
|
|
|
|
btn_class: btn--inverse
|
|
|
|
btn_label: View examples
|
|
|
|
image_path: /images/keyboard-padding.png
|
|
|
|
url: /docs/examples
|
2016-09-07 03:19:16 +00:00
|
|
|
excerpt: '
|
|
|
|
|
|
|
|
Need some inspiration? Here are some example dotfiles repository.
|
|
|
|
|
2019-10-20 20:07:13 +00:00
|
|
|
'
|
|
|
|
- title: Contribute
|
|
|
|
alt: Contribute
|
|
|
|
btn_class: btn--inverse
|
|
|
|
btn_label: Read guidlines
|
|
|
|
image_path: /images/hands-padding.png
|
|
|
|
url: https://github.com/TheLocehiliosan/yadm/blob/master/.github/CONTRIBUTING.md
|
|
|
|
excerpt: '
|
|
|
|
|
|
|
|
Improve yadm by reporting bugs, coding changes, documentation and
|
|
|
|
packaging yadm installations.
|
|
|
|
|
2016-09-07 03:19:16 +00:00
|
|
|
'
|
|
|
|
---
|
|
|
|
|
|
|
|
{% include feature_row id="intro" type="center" %}
|
|
|
|
|
|
|
|
{% include feature_row %}
|
2020-12-28 03:02:07 +00:00
|
|
|
|
|
|
|
If you enjoy using yadm, consider
|
|
|
|
[adding a star to the repository](https://github.com/TheLocehiliosan/yadm)
|
|
|
|
on GitHub. The star count helps others discover yadm.
|