0.0.0 • Published 4 months ago

git-intent v0.0.0

Weekly downloads
-
License
MIT
Repository
-
Last release
4 months ago

git-intent

Git workflow tool for intentional commits - Define your commit intentions before coding to write more meaningful and purposeful code.

Installation & Usage

You can use this tool without installation via npx:

npx gintent [command]

Or install it globally:

npm install -g gintent

Git Integration

You can also use it as a git command by adding an alias to your git config:

git config --global alias.intent '!npx gintent'

Then you can use it like this:

git intent [command]

Commands

Create a new intent

npx gintent "implement login form"
# or
npx gintent  # will prompt for commit message

List all intents

npx gintent list

Start working on an intent

npx gintent start [id]  # id is optional, will prompt if not provided

Check current status

npx gintent status

Finish current intent

npx gintent finish

How it works

  1. Define your intent: Before you start coding, define what you're going to commit.
  2. Start working: Begin implementing your intent.
  3. Finish with purpose: Complete your work with a clear, pre-defined commit message.

This workflow helps you:

  • Write more focused and purposeful code
  • Create cleaner, more meaningful commits
  • Stay aligned with your original intentions

License

MIT