An open API service indexing awesome lists of open source software.

https://github.com/eunseo9311/commit-cat


https://github.com/eunseo9311/commit-cat

desktop-pet developer-tools git github open-source pomodoro productivity react rust system-tray tauri

Last synced: 3 days ago
JSON representation

Awesome Lists containing this project

README

          

# CommitCat πŸˆβ€β¬›

A developer desktop companion that grows with your coding activity.

![CommitCat on desktop](assets/example.png)

CommitCat lives on your desktop, watches your development environment locally, and reacts to your work β€” commits, coding time, focus sessions, and more.

> 🐱 A tiny coding partner that never judges you (even at 3 AM).

---

## ✨ Features

### Core
- 🐾 Desktop pet with pixel-art sprites β€” walks, sits, sleeps, and celebrates
- πŸ‘£ Menu bar / system tray companion (streak tooltip)
- πŸ–±οΈ Draggable β€” place it anywhere on your screen
- πŸ–±οΈ Click-through β€” transparent areas pass clicks to the desktop
- πŸ’¬ Click to chat (speech bubble reactions with personality)
- πŸ’¬ Random coding messages β€” cat reacts while you code
- 🎨 Multi-color cat (orange / brown / white)
- 🐾 Petting β€” right-click & swipe to pet the cat with tiered reactions
- πŸ’€ Sleeps when you're away
- πŸ–₯️ Fullscreen-aware β€” auto-hides when you go fullscreen

### Coding Activity
- πŸ™ Local Git commit & push tracking β€” reacts every time you commit
- πŸ’» IDE detection β€” knows when you're coding (VS Code, JetBrains, Xcode, and more)
- πŸŒ™ Late-night coding awareness
- 🌱 XP & level system β€” grows with your activity
- πŸ”₯ Streak system β€” 3/7/30-day milestones with bonus XP
- ✨ Pixel-art level-up animation with burst particles

### Focus & Productivity
- ⏱️ Pomodoro focus timer with break timer
- πŸ“Š Daily summary timeline (right-click β†’ Today) β€” view commits, coding time, XP earned, and event history

### Integrations
- πŸ™ GitHub integration β€” PR open/merge XP, star notifications
- πŸ€– Claude AI chat β€” double-click the cat to chat with your AI companion (Anthropic API)
- 🧩 VSCode Extension β€” install from the [VSCode Marketplace](https://marketplace.visualstudio.com/items?itemName=commitcat.commitcat) for seamless IDE detection
- πŸ”” macOS Notification Center β€” system notifications for key events
- πŸ”„ Auto-update checker β€” notifies when a new version is available

### IDE Plugins
- πŸ“¦ [VS Code Extension](https://marketplace.visualstudio.com/items?itemName=commitcat.commitcat) β€” coding time, file saves, build tracking
- πŸ“¦ JetBrains Plugin (IntelliJ, WebStorm, PyCharm, GoLand, CLion, RustRover) β€” coding time, file saves, build tracking

### Settings
- βš™οΈ Settings panel β€” manage watched repos, cat color, timer durations, API keys, and XP progress
- 🐳 Docker activity awareness β€” container start/build detection with XP

---

## 🧠 How It Grows

CommitCat gains XP from:

| Activity | XP |
|---|---|
| Git commit | +10 XP |
| Git push | +5 XP |
| 1 hour of coding | +5 XP |
| Late-night session | +15 XP |
| Pomodoro complete | +20 XP |
| GitHub PR opened | +20 XP |
| GitHub PR merged | +30 XP |
| Docker container start | +5 XP |
| Docker build complete | +15 XP |
| 3-day streak | +50 XP |
| 7-day streak | +100 XP |
| 30-day streak | +500 XP |

Level up formula: **Level n β†’ n+1 requires n Γ— 100 XP**

The more you build, the happier it becomes.

---

## πŸ”’ Privacy First

CommitCat is designed for developers who care about privacy.

- ❌ No code is collected
- ❌ No keystrokes are recorded
- ❌ No files are uploaded
- ❌ No telemetry by default

βœ”οΈ All data is stored locally on your machine
βœ”οΈ External integrations (GitHub, AI) are opt-in only

---

## πŸ–₯️ Platforms

- βœ… macOS
- βœ… Windows
- βœ… Linux

---

## πŸ“¦ Installation

Download from the [Releases page](https://github.com/eunseo9311/commit-cat/releases).

**macOS**
```
CommitCat.dmg
```

> **macOS Gatekeeper κ²½κ³  μ‹œ:**
> 앱이 μ½”λ“œμ‚¬μΈλ˜μ§€ μ•Šμ•„ "μ†μƒλ˜μ—ˆκΈ° λ•Œλ¬Έμ— μ—΄ 수 μ—†μŠ΅λ‹ˆλ‹€" κ²½κ³ κ°€ λ‚˜μ˜¬ 수 μžˆμŠ΅λ‹ˆλ‹€.
> ν„°λ―Έλ„μ—μ„œ μ•„λž˜ λͺ…λ Ήμ–΄λ₯Ό μ‹€ν–‰ν•˜λ©΄ ν•΄κ²°λ©λ‹ˆλ‹€:
> ```
> xattr -cr /Applications/Commit\ Cat.app
> ```

**Windows**
```
CommitCat-Setup.exe
```

**Linux**
```
CommitCat.AppImage # Most distros
CommitCat.deb # Debian/Ubuntu
```

> **Wayland (Hyprland, Sway λ“±) μ‚¬μš© μ‹œ EGL μ—λŸ¬κ°€ λ°œμƒν•˜λ©΄:**
> ```
> WEBKIT_DISABLE_DMABUF_RENDERER=1 commit-cat
> ```
> λ˜λŠ” X11 λ°±μ—”λ“œλ₯Ό μ‚¬μš©ν•˜μ„Έμš”:
> ```
> GDK_BACKEND=x11 commit-cat
> ```

### VSCode Extension
Search **"CommitCat"** in the VSCode Extensions tab, or install directly from the [Marketplace](https://marketplace.visualstudio.com/items?itemName=commitcat.commitcat).

### Build from source

```bash
git clone https://github.com/eunseo9311/commit-cat.git
cd commit-cat
npm install
npm run tauri dev
```

**Requirements:** Node.js, Rust, Tauri CLI

---

## πŸ› οΈ Built With

- [Tauri](https://tauri.app/) β€” lightweight desktop framework
- [React](https://react.dev/) β€” UI
- [Rust](https://www.rust-lang.org/) β€” system integration, Git & IDE tracking
- [Anthropic API](https://docs.anthropic.com/) β€” AI chat (optional)

---

## πŸ—ΊοΈ Roadmap

**MVP βœ…**
- [x] Desktop pet rendering
- [x] Activity & IDE detection
- [x] Local Git integration
- [x] XP & growth system
- [x] Tray / menu bar UI
- [x] Settings panel

**v1.0 β€” Local Complete βœ…**
- [x] Pomodoro focus timer with break timer
- [x] Daily coding summary & event timeline
- [x] GitHub integration (PR tracking, star notifications)
- [x] Claude AI chat companion
- [x] macOS / Windows / Linux support
- [x] Docker integration
- [x] IDE plugins (VS Code Extension, JetBrains Plugin)
- [x] Petting interaction & click-through

**v1.1 β€” Architecture Refactor βœ…**
- [x] Cargo workspace + `commit-cat-core` crate extraction
- [x] Platform trait abstraction (`#[cfg]` cleanup)
- [x] Remove duplicated model files in `src-tauri`
- [x] State machine integration (core as single source of truth)

**v1.2 β€” Design & Items βœ…**
- [x] Item system foundation (hats, accessories, inventory UI)
- [x] Grab sprite system (color-specific drag animations)
- [x] AI provider/model selection (Claude + OpenAI GPT)
- [x] Cat design renewal
- [x] Item positioning & motion polish (per-state sprite alignment)
- [x] Auto-equip items (birthday hat, commit streak crown, etc.)

**v1.3 β€” IDE Plugins 🧩**
- [x] JetBrains plugin marketplace preparation
- [ ] JetBrains Extension marketplace release

**v1.4 β€” VSCode Webview πŸ–₯️**
- [ ] Cat rendering inside VSCode (Webview Panel)
- [ ] Environment detection (desktop / Codespaces / web)

**v2.0 β€” Cloud ☁️**
- [ ] Cloud API server (Rust + Axum)
- [ ] Cross-device sync (event-based, offline-first)
- [ ] GitHub OAuth

**v2.1 β€” Badge & Profile πŸ…**
- [ ] GitHub README badge (`![CommitCat](api.commitcat.dev/badge/user)`)
- [ ] Public profile page
- [ ] GitHub Codespaces support

**v3.0 β€” Multi-Platform 🌐**
- [ ] Discord bot integration
- [ ] External app widgets
- [ ] Community features (leaderboard, team stats)

---

## 🀝 Contributing

Contributions are welcome!

- Open an issue
- Suggest features
- Submit pull requests

---

## πŸ“œ License

MIT License

---

## πŸ’¬ Status

v1.2 complete β€” working on v1.3 IDE plugins
If you like the idea, consider giving the repo a ⭐