README.md


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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80

<p align="center">
  <img src="./assets/banner.png">
  <br>
  Easy-to-use CUI for fixing git conflicts
  <br>
  <br>
  <p align="center">
    <a href="https://travis-ci.org/mkchoi212/fac">
      <img src="https://travis-ci.org/mkchoi212/fac.svg?branch=master">
    </a>
    <a href="https://goreportcard.com/report/github.com/mkchoi212/fac">
      <img src="https://goreportcard.com/badge/github.com/mkchoi212/fac">
    </a>
    <a href="https://codecov.io/gh/mkchoi212/fac">
      <img src="https://codecov.io/gh/mkchoi212/fac/branch/master/graph/badge.svg">
    </a>
  </p>
</p>
<br>

I never really liked any of the `mergetools` out there so I made a program that is somewhat easier to use.

![Preview](https://i.imgur.com/GsJMRIp.gif)

## 👷 Installation

Execute:

```bash
$ go get github.com/mkchoi212/fac
```

Or using [Homebrew 🍺](https://brew.sh)

```bash
brew tap mkchoi212/fac https://github.com/mkchoi212/fac.git
brew install fac
```

## 🔧 Using

`fac` operates much like `git add -p` . It has a prompt input at the bottom of the screen where the user inputs various commands.

The commands have been preset to the following specifications

| Keybinding                      | Description          |
| ------------------------------- | -------------------- |
| <kbd>w</kbd>                    | show more lines up   |
| <kbd>s</kbd>                    | show more lines down |
| <kbd>a</kbd>                    | use local version    |
| <kbd>d</kbd>                    | use incoming version |
| <kbd>e</kbd>                    | manually edit code   |
| <kbd>j</kbd>                    | scroll down          |
| <kbd>k</kbd>                    | scroll up            |
| <kbd>v</kbd>                    | [v]iew orientation   |
| <kbd>n</kbd>                    | [n]ext conflict      |
| <kbd>p</kbd>                    | [p]revious conflict  |
| <kbd>h</kbd>, <kbd>?</kbd>      | [h]elp               |
| <kbd>q</kbd>, <kbd>Ctrl+c</kbd> | [q]uit               |

```
[w,a,s,d,?] >> [INPUT HERE]
```

### ⚙️ Customization

The above key-bindings and various behaviors can be altered by creating a `.fac.yml` file in your home directory.
Please refer to the [configuration README.md](./binding/README.md) for more information.

## ✋ Contributing

This is an open source project so feel free to contribute by

- Opening an [issue](https://github.com/mkchoi212/fac/issues/new)
- Sending me feedback via [email](mailto://mkchoi212@icloud.com)
- Or [tweet](https://twitter.com/Bananamlkshake2) at me!

## 👮 License

See [License](./LICENSE)