dotconfig 0.2.0

A tool for symlinking configuration files from a central repository to their respective locations on the system in a repeatable, configurable way. 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60

# Dotconfig

A tool for symlinking configuration files from a central repository to their respective locations on
the system in a repeatable, configurable way.

## Install
### Using cargo:
```
cargo install dotconfig
```
### Using a package manager:
+ **Archlinux** (`yay` or another AUR helper will also work)
```
paru -S dotconfig
```

## Configuration
By default `dotconfig` will look for the directory `~/.cfg`, which is assumed to contain all of your
dotfiles as well as `symlinks.yml`, which is a listing of all of the desired symlinks you would like
`dotconfig` to make for you.

The format of `symlinks.yml` should be as follows:

```yaml
links:
  - link:
    path: ~/.zshrc
    origin: zshrc
  - link:
    path: ~/.config/alacritty/alacritty.yml
    origin: alacritty-config.yml
# ...
```
In this example, `dotconfig` would create the following two symlinks:
```
~/.zshrc -> ~/.cfg/zshrc
~/.config/alacritty/alacritty.yml -> ~/.cfg/alacritty-config.yml
```

## Usage
```
dotconfig [OPTIONS]
```

## Options
```
-c, --config <CONFIG>    Specify the YAML file that lists your desired symlinks [default: symlinks.yml]
-d, --dir <DIR>          Specify the directory that holds your config files [default: $HOME/.cfg]
-h, --help               Print help information
-V, --version            Print version information
```

## Example usage

In the following example, `dotconfig` will read `~/my-dotfiles/links.yml`, and all links will be
made to the `~/my-dotfiles` directory.

```sh
dotconfig -d ~/my-dotfiles -c links.yml
```