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

https://github.com/moeyui1/claude-status-pet

A desktop pet that shows what your AI coding assistant is doing β€” in real time. πŸ¦€
https://github.com/moeyui1/claude-status-pet

ai claude-code copilot cute github nodejs rust

Last synced: 3 months ago
JSON representation

A desktop pet that shows what your AI coding assistant is doing β€” in real time. πŸ¦€

Awesome Lists containing this project

README

          

# Claude Status Pet

[English](README.md) | [δΈ­ζ–‡](README.zh-CN.md)

[![Build and Release](https://img.shields.io/github/actions/workflow/status/moeyui1/claude-status-pet/release.yml?style=flat-square&logo=github&label=build)](https://github.com/moeyui1/claude-status-pet/actions/workflows/release.yml)
[![Latest Release](https://img.shields.io/github/v/release/moeyui1/claude-status-pet?style=flat-square&logo=github&color=blue)](https://github.com/moeyui1/claude-status-pet/releases/latest)
[![Downloads](https://img.shields.io/github/downloads/moeyui1/claude-status-pet/latest/total?style=flat-square&logo=github&label=downloads)](https://github.com/moeyui1/claude-status-pet/releases/latest)
[![License](https://img.shields.io/github/license/moeyui1/claude-status-pet?style=flat-square&color=green)](LICENSE)
[![Platform](https://img.shields.io/badge/platform-Windows%20%7C%20macOS%20%7C%20Linux-lightgrey?style=flat-square&logo=tauri)](https://github.com/moeyui1/claude-status-pet/releases)
[![Made with Rust](https://img.shields.io/badge/made%20with-Rust-orange?style=flat-square&logo=rust)](https://www.rust-lang.org/)

A desktop pet that shows what your AI coding assistant is doing β€” in real time. πŸ¦€

Ferris demo

Kuromi demo

Mona demo

ASCII demo

πŸ“Έ More screenshots

Ferris in action

Kuromi in action

## Quick Start

**Option 1 β€” Plugin install** (Claude Code):

```
/plugin marketplace add moeyui1/claude-status-pet
/plugin install claude-status-pet
```

**Option 1b β€” Plugin install** (GitHub Copilot CLI):

```
copilot plugin marketplace add moeyui1/claude-status-pet
copilot plugin install claude-status-pet-copilot
```

Then run `/pet update` to download the binary and assets.

**Option 2 β€” Ask your AI agent** (Claude Code or Copilot CLI):

> Read https://raw.githubusercontent.com/moeyui1/claude-status-pet/main/docs/INSTALL.md and install it for me

That's it! A pet will appear on your next session. πŸŽ‰

## Features

- πŸ”΄ **Real-time status** β€” watch your pet react as the assistant reads, edits, searches, thinks
- 🎭 **10+ characters** β€” Ferris (SVG), Mona & Kuromi (GIF DLC), and 6 ASCII art buddies
- πŸ’ƒ **Animated** β€” unique animations per state (floating, wiggling, bouncing, sleeping)
- πŸͺŸ **Multi-session** β€” each session gets its own pet window
- 🎨 **Customizable** β€” right-click to change character, colors, font size
- ⚑ **Lightweight** β€” ~5MB binary, ~20MB RAM (built with Tauri)

## Usage

**Right-click** the pet to open the menu:
- Switch character (Ferris, Mona, Kuromi, Chonk, Cat, Ghost, Robot, Duck, Axolotl, Snail)
- Customize colors, background, font size
- Exit the pet

**`/pet` commands** (in Claude Code or Copilot CLI):

| Command | Action |
|---------|--------|
| `/pet` or `/pet on` | Launch the pet |
| `/pet update` | Update binary, hooks, skill, and assets |
| `/pet status` | Show config and active sessions |

> **Tip:** Switch characters and customize colors via the right-click menu.

### Create Your Own Character

Ask your AI assistant:

> Read https://raw.githubusercontent.com/moeyui1/claude-status-pet/main/docs/CUSTOM-CHARACTERS.md and create a custom character pack for me

## GitHub Copilot Support

Also works with **GitHub Copilot CLI**! Install via plugin:

```
copilot plugin marketplace add moeyui1/claude-status-pet
copilot plugin install claude-status-pet-copilot
```

Or see [`copilot/README.md`](copilot/README.md) for manual setup.

Both tools can run simultaneously β€” each gets its own pet window.

> πŸ’‘ Extensible to any AI agent with hook support β€” [PRs welcome](CONTRIBUTING.md#adding-a-new-ai-agent-adapter)!

## Compatibility

| AI Agent | Plugin Install | Manual Install | Status |
|----------|:---:|:---:|--------|
| [Claude Code](https://docs.anthropic.com/en/docs/claude-code) (CLI) | βœ… | βœ… | Fully supported |
| [GitHub Copilot CLI](https://docs.github.com/en/copilot/how-tos/copilot-cli) | βœ… | βœ… | Fully supported |
| VS Code Copilot (Agent Mode) | βœ… | βœ… | Fully supported |
| Cursor | β€” | β€” | Not supported yet |
| OpenCode | β€” | β€” | Not supported yet |

> Want to add support for another agent? See [Adding a New Adapter](CONTRIBUTING.md#adding-a-new-ai-agent-adapter).

## Other Installation Methods

πŸ”§ Build from source

Prerequisites: [Rust](https://rustup.rs/), [Node.js](https://nodejs.org/)

```bash
git clone https://github.com/moeyui1/claude-status-pet.git
cd claude-status-pet/pet-app
npm install
npx tauri build
```

Binary output: `pet-app/src-tauri/target/release/claude-status-pet(.exe)`

## Uninstall

The easiest way β€” run in your AI assistant:

```
/pet uninstall
```

This stops the pet, removes all data, scripts, and assets. Then uninstall the plugin:

- Claude Code: `/plugin uninstall claude-status-pet`
- Copilot CLI: `copilot plugin uninstall claude-status-pet-copilot`

## How It Works

```
πŸ€– AI Assistant ──hook event──▢ πŸ“ write-status ──JSON──▢ πŸ¦€ Desktop Pet (Tauri)
(Claude / Copilot) status-{id}.json file watcher β†’ UI update
```

The pet is **decoupled from any specific tool** β€” it just watches a JSON status file. See [`docs/HOOKS.md`](docs/HOOKS.md) for the full hook event β†’ status mapping and how to add support for other assistants.

## Credits

- **Ferris**: [free-ferris-pack](https://github.com/MariaLetta/free-ferris-pack) by Maria Letta (CC0)
- **Mona**: [GitHub on GIPHY](https://giphy.com/GitHub) (downloaded at runtime)
- **Kuromi**: [Sanrio Korea on GIPHY](https://giphy.com/SanrioKorea) (downloaded at runtime)
- **ASCII sprites**: inspired by [any-buddy](https://github.com/cpaczek/any-buddy) by cpaczek
- Built with [Tauri](https://tauri.app/)

## License

[AGPL-3.0-only](LICENSE)