🦜 coParrot

> Your intelligent, multilingual Git assistant powered by AI

coParrot is an AI-powered CLI tool that makes Git operations smarter and more intuitive. Generate meaningful commit messages, commit files individually or in groups, and let AI understand your changes - all in your preferred language.


✨ Features

- 🤖 AI-Generated Commit Messages - Let AI analyze your changes and create meaningful commit messages
- 🔄 Smart File Commits - Commit files individually or group them by patterns
- 🌍 Multilingual Support - English, Portuguese (pt-BR), and Spanish
- 🎯 Interactive File Selection - Choose which files to stage with an intuitive interface
- ⚙️ Flexible Configuration - Support for OpenAI, Claude, and Gemini
- 📋 Commit Conventions - Conventional Commits, Gitmoji, or custom formats
- 🎨 Beautiful CLI - Progress bars, colors, and clean output
- 🔧 Customizable - Configure commit styles, branch naming, and more

📦 Installation

$3

``bash
npm install -g coparrot
`

$3

`bash
npm install coparrot
`

🚀 Quick Start

$3

Run coParrot for the first time to configure:

`bash
coparrot
`

The interactive setup will guide you through:
1. Language Selection - Choose your preferred language
2. Provider Setup - Select OpenAI, Claude, or Gemini
3. API Key - Enter your API key
4. Preferences - Configure commit conventions, code review style, etc.

$3

`bash


Start coParrot

`bash
> add
`

Features:
- ✅ Multi-select files with Space
- 🔍 Search and filter by filename
- 📊 Shows file status (Modified, Added, Deleted, etc.)

---

$3

Generate an AI commit message for staged files:

`bash
> commit
`

Process:
1. Analyzes your staged changes
2. Generates a contextual commit message
3. Shows message for approval
4. Options to approve, retry, or customize

Example Output:
`
══════════════════════════════════════════
AI Generated Message:
══════════════════════════════════════════

feat: add multilingual support for Spanish

══════════════════════════════════════════

✔ What would you like to do?
✓ Approve and use this response
↻ Retry (generate a new response)
✎ Retry with custom instructions
`

---

$3

Commit each changed file individually with AI-generated messages:

`bash
> squawk

With patterns

Options:
- --ignore - Ignore files matching glob patterns
- --group - Group files by pattern (one commit per group)

Example:
`
🦜 Squawk Progress:
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

📦 [1/3] *.json (2 files) ............... ✓
📄 [2/3] script.js ...................... ✓
📄 [3/3] README.md ...................... ✓

✨ 3 commits created (4 files)
• 1 group commits (2 files)
• 2 individual commits

⏱️ Completed in 12.3s
`

Grouping Examples:
`bash


Group all JSON files together, all PNG files together

`bash
> status
`

Displays:
- Current branch
- Modified files
- Untracked files
- Staged files

---

$3

Update your coParrot configuration:

`bash
> setup
`

What you can change:
- Language preference
- LLM provider and API key
- Model selection
- Commit message convention
- Branch naming convention
- Code review style
- PR message style
- Custom instructions

---

$3

Create and switch to new branches:

`bash
> checkout -b feature-branch
> checkout --ai # AI generates branch name
`

---

⚙️ Configuration

$3

`
~/.coparrot/config.json
`

$3

`json
{
"language": "en",
"provider": "openai",
"apiKey": "your-api-key",
"model": "gpt-4",
"commitConvention": {
"type": "conventional"
},
"branchNaming": {
"type": "gitflow"
}
}
`

$3

Conventional Commits (Default)
`
feat: add new feature
fix: resolve bug
docs: update documentation
`

Gitmoji
`
✨ add new feature
🐛 fix bug
📝 update documentation
`

Simple
`
add new feature
fix bug
update documentation
`

Custom
Define your own format with placeholders like {type}, {scope}, {message}

$3

| Provider | Models |
|----------|--------|
| OpenAI | GPT-4, GPT-3.5-turbo |
| Claude | Claude 3 Opus, Sonnet, Haiku |
| Gemini | Gemini Pro |

$3

- OpenAI: https://platform.openai.com/api-keys
- Claude: https://console.anthropic.com/settings/keys
- Gemini: https://makersuite.google.com/app/apikey

🌍 Multilingual Support

coParrot supports three languages:

- 🇺🇸 English (en)
- 🇧🇷 Portuguese (pt-BR)
- 🇪🇸 Spanish (es)

All UI elements, messages, and prompts are fully localized. Change language in setup:

`bash
> setup


Select "Escolha seu idioma preferido" / "Choose your preferred language"

`bash
> commit --yes
> squawk --yes
`

$3

Group multiple file types strategically:

`bash


Group configs, components, and tests separately

`
coparrot/
├── bin/
│ └── index.js # CLI entry point
├── src/
│ ├── commands/ # Command implementations
│ │ ├── add.js
│ │ ├── commit.js
│ │ ├── squawk.js
│ │ └── checkout.js
│ ├── services/ # Core services
│ │ ├── config.js # Configuration management
│ │ ├── git.js # Git operations
│ │ ├── llms.js # LLM orchestration
│ │ ├── i18n.js # Internationalization
│ │ └── prompts.js # AI prompt templates
│ ├── lib/ # UI components
│ │ ├── cli.js # CLI framework
│ │ ├── renderer.js # Markdown renderer
│ │ └── streamer.js # Streaming output
│ └── utils/ # Utilities
│ ├── glob.js # Pattern matching
│ └── repo-stats.js # Repository statistics
├── locales/ # Translations
│ ├── en.json
│ ├── pt-BR.json
│ └── es.json
└── package.json
``

🤝 Contributing

We welcome contributions! Please see CONTRIBUTING.md for:

- Development setup
- Code structure guidelines
- How to add new commands
- Testing guidelines
- Pull request process

Quick Links:
- 🐛 Report a Bug
- 💡 Request a Feature
- 🔧 Submit a PR

📄 License

This project is licensed under a Custom Non-Commercial License - see the LICENSE file for details.

TL;DR:
- ✅ Free for personal use
- ✅ Can modify and redistribute (non-commercial)
- ❌ Cannot sell or use commercially without permission

🙏 Acknowledgments

- Built with OpenAI, Anthropic, and Google Gemini
- Inspired by modern developer workflows
- Thanks to all contributors

📞 Support

- Issues: GitHub Issues
- Email: ddvital0@gmail.com
- Discussions: GitHub Discussions

---