1<!--
 2SPDX-FileCopyrightText: Amolith <amolith@secluded.site>
 3
 4SPDX-License-Identifier: CC0-1.0
 5-->
 6
 7```
 8$ formatted-commit -h
 9
10  formatted-commit helps you create well-formatted Git commits that follow
11  the Conventional Commits specification with proper subject length validation,
12  body wrapping, and trailer formatting.
13
14  USAGE
15
16
17    formatted-commit [--flags]
18
19
20  EXAMPLES
21
22
23    # With co-author
24    formatted-commit -t feat -m "do a thing" -t "Crush <crush@charm.land>"
25
26    # Breaking change with longer body
27    formatted-commit -t feat -m "do a thing that borks a thing" -B "$(cat <<'EOF'
28    Multi-line
29    - Body
30    - Here
31
32    This is what borked because of new shiny, this is how migrate
33    EOF
34    )"
35
36    # Including scope for more precise changes
37    formatted-commit -t refactor -s "web/git-bug" -m "fancy shmancy" \
38      -b "Had to do a weird thing because..."
39
40
41  COMMANDS
42
43    help [command]  Help about any command
44
45  FLAGS
46
47    -b --body       Commit body (optional)
48    -B --breaking   Mark as breaking change (optional)
49    -h --help       Help for formatted-commit
50    -m --message    Commit message (required)
51    -s --scope      Commit scope (optional)
52    -T --trailer    Trailer in 'Sentence-case-key: value' format (optional, repeatable)
53    -t --type       Commit type (required)
54    -v --version    Version for formatted-commit
55```