24 releases (4 breaking)
0.5.1 | Sep 13, 2024 |
---|---|
0.5.0 | Sep 13, 2024 |
0.4.4 | Aug 20, 2024 |
0.3.4 | Aug 6, 2024 |
0.1.9 | Jul 24, 2024 |
#806 in Development tools
1,896 downloads per month
23KB
528 lines
Gim
Commit Driven Development Git-CLI Command Line Utility
Installation
Functionality
gim
provides the following commands:
gim set {COMMIT_MESSAGE}
- Accepts a string argument for the planned commit message.
- The commit message is stored inside the
.COMMIT_MESSAGE
file.Note: Don't worry about adding a
.COMMIT_MESSAGE
file yourself (or adding it to.gitignore
),gim
takes care of that for you! - replaces the current commit message
gim edit
- Opens system default editor to edit current commit message
gim add {ADDED_MESSAGE}
- Appends the
ADDED_MESSAGE
to the current commit message. Used for multiline commits
gim push
- Equivalent to
git add . && git commit -m $COMMIT_MESSAGE && git push
. - Allows optional argument for inclusion of specific files, similar to
git add $FILES
. - Upon a successful push, the
.COMMIT_MESSAGE
file is cleared, excluding comments.
gim status
or just gim
- Displays the current
gim
planned commit message at the top of the normalgit status
output.
gim clear
- Clears the stored commit message.
gim clear full
- Fully clears the stored commit message, comments included.
gim help
- Prints the command descriptions to the console.
Dependencies
~2–10MB
~116K SLoC