whatthecommitcli 0.1.1

Generate commit messages from your terminal, inspired by whatthecommit.com
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

# What The Commit CLI

[whatthecommit.com](https://whatthecommit.com) but local.

## Installation

```bash
cargo install whatthecommitcli
```

## Usage

### Default

Generate a random commit message using built-in defaults:

```bash
whatthecommitcli
```

Use it directly with git:

```bash
git commit -m "$(whatthecommitcli)"
```

### Customization Options

```bash
Usage: whatthecommitcli [OPTIONS]

Options:
  -n, --names <FILE>                     Optional path to a custom names file
  -c, --commit-messages-template <FILE>  Optional path to a custom commit messages template file
  -h, --help                             Print help
  -V, --version                          Print version
```

### Template Placeholders

The commit message templates support three placeholders for name substitution:

- `XNAMEX` - Replaces with the name as-is (e.g., "John")
- `XLOWERNAMEX` - Replaces with lowercase version (e.g., "john")
- `XUPPERNAMEX` - Replaces with uppercase version (e.g., "JOHN")

## License

Dual-licensed under [Apache 2.0](LICENSE-APACHE) or [MIT](LICENSE-MIT).

The default [commit messages](src/commit_messages.txt) and [names](src/names.txt)
are sourced from https://github.com/ngerakines/commitment.