Automatic syncing of desktop files to git

Go to file

Joshua Potter 8db3c4b4ab Various cleanup and daemon template.		2021-12-30 09:58:59 -05:00
.githooks	Read in config file or search appropriate places.	2021-12-29 11:06:25 -05:00
examples	Various cleanup and daemon template.	2021-12-30 09:58:59 -05:00
src	Various cleanup and daemon template.	2021-12-30 09:58:59 -05:00
.envrc	Basic project template.	2021-12-28 17:06:17 -05:00
.gitignore	Basic project template.	2021-12-28 17:06:17 -05:00
Cargo.toml	Add first pass on ideas for generating the config.	2021-12-30 08:25:29 -05:00
README.md	Idea on how `configure` might work.	2021-12-29 19:02:58 -05:00
flake.lock	Basic project template.	2021-12-28 17:06:17 -05:00
flake.nix	Various cleanup and daemon template.	2021-12-30 09:58:59 -05:00

README.md

homesync

Caution! This is unstable code!

Introduction

Homesync provides a way of automatically syncing config files across various applications you may use. It works by establishing a file watcher on all the configs specified in the primary homesync config. As files are changed, they are copied to a local git repository to eventually be pushed by the user. Likewise, at any point, the user can sync against the remote repository, overwriting local configurations for one or more packages.

Installation

TODO

Configuration

Homesync uses a YAML file, to be found in anyone of the following locations. Locations are searched in the following priority:

$HOME/.homesync.yml
$HOME/.config/homesync/homesync.yml
$XDG_CONFIG_HOME/homesync.yml
$XDG_CONFIG_HOME/homesync/homesync.yml

That said, it is recommended to modify this config solely from the exposed homesync CLI. Homesync will take responsibility ensuring the generated configuration is according to package manager, platform, etc.

Usage

TODO

Contribution

Install git hooks as follows:

git config --local core.hooksPath .githooks/