git-squad 0.3.2

Manage co-authors in git commit messages with ease
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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103

# git-squad
## Manage co-authors in git commit messages with ease

`git-squad` is a command-line tool that makes it easy to manage co-authors in
your Git commit messages. Perfect for pair programming or collaborative coding
sessions, it lets you quickly add or remove co-authors without having to
manually edit commit templates.

## Features

- Maintain a list of collaborators (buddies) with their names and emails
- Add and remove co-authors in the current git session
- Automatically updates your git commit template
- Simple command-line interface
- Shell completions for commands and buddies

## Usage 

![git-squad demo tape](https://github.com/ccntrq/git-squad/raw/master/assets/demo.gif)

```
Manage co-authors in git commit messages with ease

Usage: git-squad [OPTIONS] [COMMAND]

Commands:
  with             Add buddies to the current session
  without          Remove buddies from the current session
  alone            Remove all buddies from the current session
  create           Create a new buddy
  forget           Delete a buddy from the list of available buddies
  info             List both active and available buddies
  list             List all available buddies
  active           List active buddies in the current session
  completions      Generate completions for your shell
  migrate-buddies  Migrate buddies from old yaml format to new toml format
  help             Print this message or the help of the given subcommand(s)

Options:
      --buddies-file <BUDDIES_FILE>  Use a custom buddy file instead of ~/.config/git-squad/buddies.toml
  -h, --help                         Print help
```

## Installation

### Prerequisites

- Git must be installed and configured
- Rust and Cargo must be installed

### Install published version from crates.io

```bash
cargo install git-squad
```

### Building the latest development version

1. Clone the repository:

```bash
git clone git@github.com:ccntrq/git-squad.git
cd git-squad
```

2. Build and install with Cargo:

```bash
cargo install --path .
```


## Setup

Before using `git-squad`, you need to set up a git commit template. You can
either setup a global one or do this per repo.

### Global

```bash
# Create a template file
touch ~/.gitmessage

# Configure git to use it
git config --global commit.template ~/.gitmessage
```

### Per repo

```bash
# Inside your repo dir
# Create a template file
touch .git/gitmessage

# Configure git to use it
git config  commit.template .git/gitmessage
```

# Related work

There is a similar tool written in typescript called
[git-mob](https://github.com/rkotze/git-mob) which I discovered while name
hunting for this tool.