seidr/README.org
Christina Sørensen 9b4283b9ec
doc(readme): added asciinema demo
Added a very basic demo, barely showing anything. Better than nothing
still, so here it is.

Signed-off-by: Christina Sørensen <christina@cafkafk.com>
2023-07-03 12:15:38 +02:00

1.4 KiB

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 (hardly, but eventually) testing helps ensure regressions aren't introduced.

That said, we're in 0.Y.Z, here be dragons for now (although a little less each commit).

Installation

$ git clone https://github.com/cafkafk/gg
$ cd gg
$ cargo install --path .

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.