Clone

git clone git@git.secluded.site:formatted-commit.git

README

formatted-commit

REUSE status Go Report Card

CLI tool that produces commits following the Conventional Commits specification through flags, made for LLMs and not really their operators (but I guess you can use this directly if you want). Operators would likely prefer, as the author does, meteor.

I've found that LLMs consistently fail to

  • Format trailers correctly: they add too many newlines between trailers, which breaks tools like git interpret-trailers
  • Include proper scope notation
  • Follow the loose 50/72 subject/body standard held by projects like the Linux kernel. I try to stick to it, but LLMs writing badly-formatted commit messages means rewording work for me once they're done.

formatted-commit enforces all of this. Where possible, we "correct" the model's input. Where that's less possible, we error. For example, instead of requiring the model wrap body text at 72 columns, we let it write whatever body it wants and wrap it ourselves. We can't really fix the subject, so formatted-commit emits an error when the subject is too long with clear indication of where the 50-character cut-off is.

Installation

You need both the binary and the prompt.

The binary

  • Using bin (highly recommended because it's one tool to manage and update myriad CLI tools distributed as statically-linked binaries, like formatted-commit)
    bin install goinstall://git.secluded.site/formatted-commit@latest
    
  • Using the go toolchain (upgrade with formatted-commit upgrade)
    go install git.secluded.site/formatted-commit@latest
    

The prompt

Paste this snippet into some section of your ~/.config/AGENTS.md or ~/.claude/CLAUDE.md or whatever titled something like ## Creating git commits.

Create/amend commits exclusively using `formatted-commit`. It has no sub-commands and the following options:
<formatted-commit_flags>
-t --type Commit type (required)
-s --scope Commit scope (optional)
-B --breaking Mark as breaking change (optional)
-m --message Commit message (required)
-b --body Commit body (optional)
-T --trailer Trailer in 'Sentence-case-key: value' format (optional, repeatable)
-a --add Stage all modified files before committing (optional)
--amend Amend the previous commit (optional)
-h --help
</formatted-commit_flags>
<formatted-commit_example>
formatted-commit -t feat -s "web/git-bug" -m "do a fancy new thing" -T "Assisted-by: GLM 4.6 via Crush" -b "$(cat <<'EOF'
Multi-line

- Body
- Here

EOF
)"
</formatted-commit_example>

Changelog

See CHANGELOG.md for release notes and version history. (Maintained by kittylog)

Contributions

Patch requests are in amolith/llm-projects on pr.pico.sh. You don't need a new account to contribute, you don't need to fork this repo, you don't need to fiddle with git send-email, you don't need to faff with your email client to get git request-pull working...

You just need:

  • Git
  • SSH
  • An SSH key
# Clone this repo, make your changes, and commit them
# Create a new patch request with
git format-patch origin/main --stdout | ssh pr.pico.sh pr create amolith/llm-projects
# After potential feedback, submit a revision to an existing patch request with
git format-patch origin/main --stdout | ssh pr.pico.sh pr add {prID}
# List patch requests
ssh pr.pico.sh pr ls amolith/llm-projects

See "How do Patch Requests work?" on pr.pico.sh's home page for a more complete example workflow.


Some other tools if this one interested you

  • nasin pali (np) - minimal todo/planning CLI for agents
  • AgentSh - press Ctrl+X from any shell prompt to message your agent (Crush, Claude Code, etc.)