Compare commits
No commits in common. "master" and "v0.1.0" have entirely different histories.
33
README.md
33
README.md
@ -1,34 +1,15 @@
|
||||
# **Use AI to Draft Commit Messages with Aicommit**
|
||||
## use AI to draft commit messages
|
||||
|
||||
Aicommit integrates with RayAI to generate a draft commit message, which is then loaded into your default editor for review and editing.
|
||||
clone this repo and then link the scripts into your path.
|
||||
|
||||
## **Prerequisites**
|
||||
requires: jq
|
||||
|
||||
To use Aicommit, you need to have the following tools installed:
|
||||
|
||||
- `curl`
|
||||
- `jq`
|
||||
|
||||
**Note**: Aicommit-groq is currently broken and should not be used.
|
||||
|
||||
## **Setup and Usage**
|
||||
|
||||
1. **Clone the repository**: Clone the Aicommit repository to your local machine.
|
||||
2. **Configure your Git editor**: Add the following line to your `~/.bashrc` file, replacing `<path/to/>` with the actual path to the Aicommit executable:
|
||||
### use
|
||||
Instead of
|
||||
|
||||
```bash
|
||||
export GIT_EDITOR="<path/to/>aicommit"
|
||||
git commit -m "your message here"`
|
||||
```
|
||||
Optionally you can add the `--groq` flag to use the Groq API.
|
||||
|
||||
```bash
|
||||
export GROQ_API_KEY=<groq-api-key>
|
||||
aicommit
|
||||
```
|
||||
|
||||
```bash
|
||||
export GIT_EDITOR="<path/to/>aicommit --groq"
|
||||
```
|
||||
|
||||
3. **Use Git as normal**: Once configured, you can use Git as you normally would. When you run `git commit`, Aicommit will generate a draft commit message using RayAI, which will then be loaded into your default editor for review and editing.
|
||||
|
||||
**Bypassing AI-generated messages**: If you prefer to write your own commit message, you can use the `-m` flag with `git commit`, like this: `git commit -m "your message here"`. This will bypass the AI-generated message and allow you to write your own message directly.
|
||||
|
75
aicommit
75
aicommit
@ -1,79 +1,66 @@
|
||||
#!/usr/bin/env bash
|
||||
#!/bin/bash
|
||||
set -e
|
||||
|
||||
TMP_FILE="/tmp/aicommit_tmp"
|
||||
ARGS=("${@-}")
|
||||
|
||||
TMP_FILE="/tmp/aicommit"
|
||||
system=$(
|
||||
cat - <<EOF
|
||||
|
||||
You are an expert programmer that values clear, unambiguous communication and are specialized in generating concise and informative git commit messages.
|
||||
Your task is to generate a concise, informative git commit message based on the following git diff.
|
||||
Be sure that the commit message reflects the entire diff.
|
||||
It is very important that the entire commit is clear and understandable.
|
||||
Only reply with the commit message and nothing else.
|
||||
Give detail for every change in the diff.
|
||||
|
||||
EOF
|
||||
)
|
||||
|
||||
pushd "$(pwd)" >/dev/null
|
||||
|
||||
hasFlag() {
|
||||
local flags=("$@")
|
||||
for var in "${ARGS[@]}"; do
|
||||
for flag in "${flags[@]}"; do
|
||||
if [[ ${flag} == "${var}" ]]; then
|
||||
echo 'true'
|
||||
return
|
||||
fi
|
||||
done
|
||||
done
|
||||
echo 'false'
|
||||
}
|
||||
|
||||
if ! diff=$(git diff --cached); then
|
||||
echo "Failed to get diff."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo ""
|
||||
echo "Please wait for AI reponse..."
|
||||
message_cat="${system} diff: ${diff}"
|
||||
|
||||
if [[ "--groq" == "$1" ]]; then
|
||||
shift
|
||||
|
||||
message=$(
|
||||
jq -n \
|
||||
".messages = [{role: \"system\", content: $(jq -R -s '@json' <<<"${system}")}, {role: \"user\", content: $(jq -R -s '@json' <<<"${diff}")}] |
|
||||
.model = \"llama-3.1-70b-versatile\" |
|
||||
.temperature = 1 |
|
||||
.max_tokens = 1024 |
|
||||
.top_p = 1 |
|
||||
.stream = false |
|
||||
.stop = null"
|
||||
)
|
||||
|
||||
curl -s "https://api.groq.com/openai/v1/chat/completions" \
|
||||
-X POST \
|
||||
-H "Content-Type: application/json" \
|
||||
-H "Authorization: Bearer ${GROQ_API_KEY}" \
|
||||
-d "${message}" | jq -r '.choices[0].message.content | gsub("\""; "")' >"${TMP_FILE}"
|
||||
|
||||
if [[ 0 -ne $? ]]; then
|
||||
echo "Failed to get response."
|
||||
exit 1
|
||||
fi
|
||||
else
|
||||
message_cat="${system} diff: ${diff}"
|
||||
|
||||
message=$(
|
||||
message=$(
|
||||
jq -n \
|
||||
".message = $(jq -R -s '@json' <<<"${message_cat}")"
|
||||
)
|
||||
)
|
||||
|
||||
# trunk-ignore(shellcheck/SC2091)
|
||||
# trunk-ignore(shellcheck/SC2310)
|
||||
if $(hasFlag -r --reset); then
|
||||
if ! curl -s -X POST https://infer.x64.world/reset-conversation >/dev/null; then
|
||||
echo "Failed to reset conversation."
|
||||
exit 1
|
||||
fi
|
||||
fi
|
||||
|
||||
curl -s "https://infer.x64.world/chat" \
|
||||
curl -s "https://infer.x64.world/chat" \
|
||||
-X POST \
|
||||
-H "Content-Type: application/json" \
|
||||
-d "${message}" | jq -r '.content | gsub("\""; "")' >"${TMP_FILE}"
|
||||
|
||||
if [[ 0 -ne $? ]]; then
|
||||
# trunk-ignore(shellcheck/SC2181)
|
||||
if [[ 0 -ne $? ]]; then
|
||||
echo "Failed to get response."
|
||||
exit 1
|
||||
fi
|
||||
fi
|
||||
|
||||
cat ".git/COMMIT_EDITMSG" >>"${TMP_FILE}"
|
||||
cat "${TMP_FILE}" >".git/COMMIT_EDITMSG"
|
||||
git commit -e -m "$(cat "${TMP_FILE}")" && rm "${TMP_FILE}"
|
||||
|
||||
rm "${TMP_FILE}"
|
||||
|
||||
"${EDITOR}" "${@-}"
|
||||
popd >/dev/null
|
||||
|
56
aicommit_groq
Executable file
56
aicommit_groq
Executable file
@ -0,0 +1,56 @@
|
||||
#!/bin/bash
|
||||
|
||||
set -e
|
||||
set -o pipefail
|
||||
|
||||
ARGS=("${@-}")
|
||||
TMP_FILE="/tmp/aicommit"
|
||||
|
||||
system=$(
|
||||
cat - <<EOF
|
||||
|
||||
You are an expert programmer that values clear, unambiguous communication and are specialized in generating concise and informative git commit messages.
|
||||
Only reply with the commit message and nothing else.
|
||||
Give detail for every change in the diff.
|
||||
|
||||
EOF
|
||||
)
|
||||
|
||||
pushd "$(pwd)" >/dev/null || exit 1
|
||||
|
||||
if [[ -z ${GROQ_API_KEY} ]]; then
|
||||
echo "API key not set."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
if ! diff=$(git diff --cached); then
|
||||
echo "Failed to get diff."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
message=$(
|
||||
jq -n \
|
||||
".messages = [{role: \"system\", content: $(jq -R -s '@json' <<<"${system}")}, {role: \"user\", content: $(jq -R -s '@json' <<<"${diff}")}] |
|
||||
.model = \"llama-3.1-70b-versatile\" |
|
||||
.temperature = 1 |
|
||||
.max_tokens = 1024 |
|
||||
.top_p = 1 |
|
||||
.stream = false |
|
||||
.stop = null"
|
||||
)
|
||||
|
||||
# trunk-ignore(shellcheck/SC2312)
|
||||
curl -s "https://api.groq.com/openai/v1/chat/completions" \
|
||||
-X POST \
|
||||
-H "Content-Type: application/json" \
|
||||
-H "Authorization: Bearer ${GROQ_API_KEY}" \
|
||||
-d "${message}" | jq -r '.choices[0].message.content | gsub("\""; "")' >"${TMP_FILE}"
|
||||
|
||||
if [[ 0 -ne $? ]]; then
|
||||
echo "Failed to get response."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
git commit -e -m "$(cat ${TMP_FILE})" && rm ${TMP_FILE}
|
||||
|
||||
popd >/dev/null || exit 1
|
Loading…
Reference in New Issue
Block a user