1.1.6 β€’ Published 5 months ago

openrouter-commit v1.1.6

Weekly downloads
-
License
MIT
Repository
github
Last release
5 months ago

openrouter-commit πŸš€ AI-Powered Git Commit Messages

Generate smart, AI-driven Git commit messages using OpenRouter models like DeepSeek R1. Automate your commit workflow and write meaningful commits effortlessly.


⚑ Quick Start

Run without installation

npx openrouter-commit -run

Install globally

npm install -g openrouter-commit
openrouter-commit -run

Use in a project (package.json)

{
    "scripts": {
        "commit": "npx openrouter-commit -run"
    }
}

Run it with:

npm run commit  # or yarn commit

πŸ”„ Updating

  • Global (del): sudo npm uninstall -g openrouter-commit
  • Global: sudo npm update -g openrouter-commit
  • npx users: npx clear-npx-cache
  • Project-based: npm update openrouter-commit

βš™οΈ Setup

API Key & Model

Option 1: .env.openrouter file (recommended)

OPENROUTER_API_KEY=your-api-key
OPENROUTER_MODEL=deepseek/deepseek-r1

Option 2: Environment variables

export OPENROUTER_API_KEY=your-api-key
export OPENROUTER_MODEL=deepseek/deepseek-r1

Option 3: Custom .env path

npx openrouter-commit -run --env-path /custom/path/.env

πŸš€ How It Works

1️⃣ Checks Git status
2️⃣ Prompts to stage changes
3️⃣ Generates an AI-powered commit message
4️⃣ Lets you confirm or edit it
5️⃣ Commits and pushes automatically


πŸ“‚ Ignored Files

By default, openrouter-commit ignores common files that shouldn't be in commits:

  • .env.openrouter
  • node_modules/, .npm/, package-lock.json
  • dist/, venv/, env/, __pycache__/, *.pyc, *.pyo, Pipfile.lock, poetry.lock
  • logs/, *.log, debug.log*, *.swp, *.swo
  • .cache/, .idea/, .editorconfig
  • .DS_Store, Thumbs.db

If needed, modify the IGNORED_FILES list in openrouter-commit's source code.


πŸ”₯ Features

βœ… AI-powered commit messages
βœ… Interactive CLI with confirmation prompts
βœ… Custom .env paths with --env-path
βœ… Handles large diffs intelligently
βœ… Failsafe exit handling (Ctrl+C won’t commit unfinished work)
βœ… Prevents accidental execution with -run flag
βœ… Ignores unnecessary files from commits


❓ Troubleshooting

Not enough OpenRouter credits?

πŸ”— Top up here

Command not found?

npx openrouter-commit -run

Or:

npm install -g openrouter-commit
openrouter-commit -run

Git push fails?

Ensure your branch is tracking a remote branch:

git branch --set-upstream-to=origin/main

πŸ’‘ About

Built by Unrealos.com – AI, SaaS, and PaaS solutions.

πŸ“œ License

MIT Β© Unrealos.com πŸš€

1.1.6

5 months ago

1.1.5

6 months ago

1.1.4

6 months ago

1.1.3

6 months ago

1.1.2

6 months ago

1.1.1

6 months ago

1.1.0

6 months ago

1.0.9

6 months ago

1.0.8

6 months ago

1.0.6

6 months ago

1.0.5

6 months ago

1.0.4

6 months ago

1.0.3

6 months ago

1.0.2

6 months ago

1.0.1

6 months ago