CLI that turns LLM input into well-formatted Conventional Commits
docs: add prompt
+30
-1
+30
-1
README.md
+30
-1
README.md
···
9
9
[](https://api.reuse.software/info/git.secluded.site/formatted-commit)
10
10
[](https://goreportcard.com/report/git.secluded.site/formatted-commit)
11
11
12
+
_Encourage LLMs towards well-formatted commits_
13
+
12
14
## Installation
13
15
14
16
```sh
15
17
go install git.secluded.site/formatted-commit@latest
16
18
```
17
19
20
+
Copy/paste into wherever you tell your models how to write commits.
21
+
22
+
```markdown
23
+
Create commits exclusively using `formatted-commit`. Try to use it normally, but
24
+
if it's not in my PATH, ask me to `go install
25
+
git.secluded.site/formatted-commit@latest`. It has no sub-commands and the following options:
26
+
<formatted-commit_flags>
27
+
-b --body Commit body (optional)
28
+
-B --breaking Mark as breaking change (optional)
29
+
-h --help Help for formatted-commit
30
+
-m --message Commit message (required)
31
+
-s --scope Commit scope (optional)
32
+
-T --trailer Trailer in 'Sentence-case-key: value' format (optional, repeatable)
33
+
-t --type Commit type (required)
34
+
-v --version Version for formatted-commit
35
+
</formatted-commit_flags>
36
+
<formatted-commit_example>
37
+
formatted-commit -t feat -s "web/git-bug" -m "do a fancy new thing" -T "Crush <crush@charm.land>" -b "$(cat <<'EOF'
38
+
Multi-line
39
+
40
+
- Body
41
+
- Here
42
+
EOF
43
+
)"
44
+
</formatted-commit_example>
45
+
```
46
+
18
47
## Usage
19
48
20
49
```text
···
34
63
35
64
36
65
# With co-author
37
-
formatted-commit -t feat -m "do a thing" -t "Crush <crush@charm.land>"
66
+
formatted-commit -t feat -m "do a thing" -T "Crush <crush@charm.land>"
38
67
39
68
# Breaking change with longer body
40
69
formatted-commit -t feat -m "do a thing that borks a thing" -B "$(cat <<'EOF'