A Rust GitOps/symlinkfarm orchestrator inspired by GNU Stow.
Find a file
Christina Sørensen a52cc15f8e
doc: added some documentation
Not very much, just enough to not be literally nothing.

Signed-off-by: Christina Sørensen <christina@cafkafk.com>
2023-07-01 14:45:23 +02:00
bin feat(git): started work on using spinners 2023-06-29 12:05:59 +02:00
doc doc(architecture): moved ARCHITECTURE.md to doc/ 2023-06-29 07:36:58 +02:00
src doc: added some documentation 2023-07-01 14:45:23 +02:00
.gitignore initial commit 2023-06-08 18:50:09 +02:00
Cargo.lock feat(git): started work on using spinners 2023-06-29 12:05:59 +02:00
Cargo.toml feat(git): started work on using spinners 2023-06-29 12:05:59 +02:00
CODE_Of_CONDUCT.md initial commit 2023-06-08 18:50:09 +02:00
flake.lock refactor: removed unused code from flake 2023-06-18 19:34:51 +02:00
flake.nix refactor: removed unused code from flake 2023-06-18 19:34:51 +02:00
LICENSE initial commit 2023-06-08 18:50:09 +02:00
README.org fix: changed config.yaml location 2023-06-18 18:06:44 +00:00

gg - git gut

A Rust GitOps/symlinkfarm orchestrator inspired by GNU Stow. Useful for dealing with "dotfiles", and with git support as a first class feature. Configuration is done throug a single yaml file, giving it a paradigm that should bring joy to those that use declarative operating systems and package managers.

Although this isn't really a case where it matters that much for performance, being written in rust instead of e.g. janky scripting languages does also mean it is snappy and reliable, and the extensive testing helps ensure regressions aren't introduced.

That said, we're in 0.0.Z, here be dragons for now.

Installation

$ git clone https://github.com/cafkafk/git
$ ./install

Configuration

If you want a template, you can copy the file from src/test/config.yaml:

$ mkdir -p ~/.config/gg/
$ cp src/test/config.yaml ~/.config/gg/config.yaml

You should seriously change this file before running any commands.

The configuration format will likely break regularly in versions 0.Y.Z.