This project provides a local-first desktop pet powered by MiniCPM, enabling users to interact with an AI companion directly on their machine. It targets users seeking a private, always-available AI assistant with a seamless, zero-setup onboarding experience, offering a unique blend of companionship and utility for everyday tasks and coding workflows.

How It Works

The application utilizes MiniCPM models (defaulting to MiniCPM5-1B-GGUF) for local inference, ensuring data privacy and offline functionality after the initial model download. It features a guided, zero-manual-setup process covering environment checks, model acquisition (smartly choosing between Hugging Face and ModelScope), and model warm-up. A key innovation is its ability to react to user activity, specifically coding actions from integrated tools, enhancing the pet's interactive nature.

Quick Start & Requirements

• Installation:
  • macOS: Download MiniCPM Desk Pet-*-arm64.dmg from Releases, drag to Applications. Launch and follow the guide. May require xattr -cr /Applications/MiniCPM\ Desk\ Pet.app if blocked.
  • Windows: Download the .exe installer from Releases and run the wizard.
• Prerequisites:
  • macOS: 14.0+, Apple Silicon (M1/M2/M3/M4), ~2 GB disk space.
  • Windows: x64 with Vulkan support, ~2 GB disk space.
  • Network: Required on first launch unless a local model file is already present.
• Links: Releases page (implied).

Highlighted Details

• Local-first inference for private, offline chat after initial setup.
• Zero-manual-setup guided onboarding: Environment Check -> Model Download -> Model Warm-up.
• Desktop companion with a floating chat bubble, usable while working.
• Agent-aware reactions to coding activity from tools like Cursor, Claude Code, and Codex.
• Smart model download management (Hugging Face/ModelScope).
• Persona support via character adapters (includes a neko-style adapter).

Maintenance & Community

The roadmap includes broader Linux validation, more persona presets, improved model download diagnostics, faster launch times, a smaller app footprint, and richer desktop-pet narration. No community links (e.g., Discord, Slack) are provided in the README.

Licensing & Compatibility

The repository is distributed under GNU AGPL-3.0-only. MiniCPM model weights are governed by the OpenBMB MiniCPM Model License. Other assets retain their own notices. The AGPL-3.0-only license is copyleft and may impose restrictions on linking with closed-source software or commercial use.

Limitations & Caveats

The primary tested platform is macOS Apple Silicon; Windows support is provided via an installer, but user feedback on issues is encouraged. An internet connection is mandatory for the first launch unless a local model file is supplied. Performance is dependent on the user's hardware (CPU, memory) and the selected model. The accuracy of coding-agent reactions can vary based on the external tool's integration.