@jdattatray.ls/navix
v1.1.0
Published
AI-powered git commit message generator
Maintainers
Readme
Navix
AI-powered Git commit message generator for developers.
Navix analyzes your staged Git changes and generates meaningful commit messages using:
- Ollama (local AI models)
- OpenAI models
Built with:
- TypeScript
- Bun
- Commander.js
- Ollama
- OpenAI SDK
Features
- Generate AI commit messages from staged Git changes
- Support for Ollama local models
- Support for OpenAI models
- Persistent configuration system
- Simple CLI workflow
- Lightweight and fast
Installation
Install Globally
npm install -g "@jdattatray.ls/navix"Setup
Navix uses a persistent configuration system.
Configuration file location:
Windows
C:\Users\YOUR_USERNAME\.navix\config.jsonLinux / macOS
~/.navix/config.jsonConfigure Ollama
First install Ollama:
https://ollama.com
Then pull a model:
ollama pull model_name- Note : You can use any model available on ollama.
Now configure Navix:
navix config --provider ollama --model model_nameConfigure OpenAI
Set your API key.
Windows
setx OPENAI_API_KEY "your-api-key"Restart terminal after setting environment variable.
Linux / macOS
export OPENAI_API_KEY="your-api-key"Now configure Navix:
navix config --provider openai --model gpt-4.1Usage
Stage Changes
git add .Generate Commit Message
navix commitNavix will:
- analyze staged changes
- generate commit message
- create Git commit automatically
Commands
Configure Provider
navix config --provider ollama --model model_namenavix config --provider openai --model model_nameCheck Current Config
navix check-configShow Raw Git Diff
navix diffShow Filtered Diff
navix filter-diffExample Workflow
git add .
navix commitExample output:
feat: add authentication middlewareArchitecture
commands/
CLI commands
config/
persistent config system
models/
AI provider abstraction layer
git_tools/
git diff and commit utilities
utils/
helper utilitiesProject Structure
src/
│
├── commands/
├── config/
├── core/
├── git_tools/
├── models/
└── utils/Requirements
- Node.js >= 18
- Git
- Ollama (optional for local AI)
- OpenAI API key (optional for cloud AI)
Author
Dattatray Jojewar
