Metadata-Version: 2.5
Name: yumii
Version: 0.14.0
Summary: Yumii — a private, voice-first AI companion for your desktop. Talks in real time, does things, remembers you — all on your own machine.
Project-URL: Homepage, https://yumii.me
Project-URL: Repository, https://github.com/CodeNeuron58/Yumii
Project-URL: Documentation, https://yumii.me
Project-URL: Bug Tracker, https://github.com/CodeNeuron58/Yumii/issues
License: MIT License
        
        Copyright (c) 2026 Biprayan Choudhuri
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Keywords: ai,anime,companion,langgraph,live2d,llm,voice,whisper
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Multimedia :: Sound/Audio :: Speech
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: >=3.12
Requires-Dist: aiohttp>=3.13.5
Requires-Dist: aiosqlite>=0.20.0
Requires-Dist: composio-langchain<0.14,>=0.13
Requires-Dist: composio<0.14,>=0.13
Requires-Dist: ddgs>=9.0.0
Requires-Dist: elevenlabs>=2.38.1
Requires-Dist: fastapi>=0.135.1
Requires-Dist: faster-whisper>=1.2.1
Requires-Dist: groq>=0.28.0
Requires-Dist: kokoro-onnx>=0.5.0
Requires-Dist: langchain-anthropic>=1.4.3
Requires-Dist: langchain-core<2.0,>=1.4
Requires-Dist: langchain-groq>=1.1.2
Requires-Dist: langchain-mcp-adapters>=0.2.0
Requires-Dist: langchain-ollama>=1.1.0
Requires-Dist: langchain-openai>=1.2.1
Requires-Dist: langchain<2.0,>=1.3
Requires-Dist: langgraph-checkpoint-sqlite>=2.0.0
Requires-Dist: langgraph-checkpoint<5.0,>=4.1
Requires-Dist: langgraph-prebuilt<2.0,>=1.1
Requires-Dist: langgraph<2.0,>=1.2
Requires-Dist: numpy>=2.4.2
Requires-Dist: onnxruntime>=1.19
Requires-Dist: pydantic-settings>=2.14.0
Requires-Dist: pydantic>=2.12.5
Requires-Dist: structlog>=24.1.0
Requires-Dist: transformers>=4.44
Requires-Dist: tzdata>=2024.1
Requires-Dist: uvicorn>=0.41.0
Requires-Dist: vosk>=0.3.45
Requires-Dist: websockets>=16.0
Provides-Extra: dev
Requires-Dist: jupyter>=1.1.1; extra == 'dev'
Requires-Dist: mypy>=1.8.0; extra == 'dev'
Requires-Dist: pytest-asyncio>=0.23.0; extra == 'dev'
Requires-Dist: pytest-timeout>=2.3.0; extra == 'dev'
Requires-Dist: pytest>=8.0.0; extra == 'dev'
Requires-Dist: ruff>=0.3.0; extra == 'dev'
Description-Content-Type: text/markdown

<div align="center">

<img src="docs/public/mascot.png" alt="Yumii" width="280">

# Yumii

**the AI companion that's actually yours.**

she talks out loud, listens in real time, does things for you —
and remembers your life together. all on your machine:
no account, no cloud, nothing ever leaves it.

[![Version](https://img.shields.io/badge/version-0.14.0-orange.svg)](CHANGELOG.md)
[![Python](https://img.shields.io/badge/python-3.12%2B-blue.svg)](https://python.org)
[![Runs on CPU](https://img.shields.io/badge/runs%20on-CPU-informational.svg)](#)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
[![GitHub stars](https://img.shields.io/github/stars/CodeNeuron58/Yumii?style=social)](https://github.com/CodeNeuron58/Yumii)

<video src="https://github.com/user-attachments/assets/f7a2a3c7-651d-4b08-ab42-e7e7adb0f48e" width="100%" controls></video>

**Experimental preview.** Windows-first; expect rough edges.

</div>

---

## Install

**Windows** (PowerShell):

```powershell
iex (irm https://yumii.me/install.ps1)
```

That's it. She lands in your Start Menu, downloads her voice and ears
the first time you open her, asks for **one API key** (a free
[Groq](https://console.groq.com) key is the easiest start), and then
you just talk.

**Updating:** re-run the same command.

## Uninstall

```powershell
uv tool uninstall yumii                       # the backend
Remove-Item "$env:LOCALAPPDATA\Yumii" -Recurse   # the app
Remove-Item "$env:APPDATA\Microsoft\Windows\Start Menu\Programs\Yumii.lnk"
```

Delete `~/.yumii` too and she forgets everything — keep it and she's
portable.

---

## What she does

- **talks in real time** — speak, interrupt, talk over her, like a real
  conversation; barge-in works
- **does things** — web search, Gmail, Calendar, Notion — every action
  behind a permission gate you control
- **remembers** — searches every past conversation, writes and corrects
  her own facts about you, knows what happened last time
- **stays local** — her voice and ears run on your CPU; pick cloud or
  fully-offline, your keys never leave the machine

## Pick a vibe

Six personalities out of the box — **Caring**, **Tsundere**, **Genki**,
**Kuudere**, **Dandere**, **Yandere** — and each one is a single text
file you can edit or write from scratch.

## Mix and match

| Role | Options |
|------|---------|
| **Mind** | Groq *(free tier)* · Gemini · OpenRouter · DeepSeek · xAI · Together · Mistral · OpenCode · **Ollama** · OpenAI · Anthropic |
| **Ears** | Local Whisper *(offline)* · Groq *(fast)* · Vosk *(offline streaming)* |
| **Voice** | **Kokoro** *(local, free)* · ElevenLabs · CAMB.ai |

Everything switches live from the in-app dashboard. Go fully offline
and nothing ever leaves the machine.

---

<div align="center">

**Private by architecture** — no account, no telemetry, no server of ours.
Your data goes only to the providers you choose, or nowhere at all.

</div>

---

## Roadmap

- **Seeing your screen** — she looks at what you're looking at and helps
- **Proactiveness** — she speaks first when it matters
- macOS & Linux shells · more voices and languages

## Contributing

The easiest contribution in open source: **a personality is one text
file** in [`src/yumii/assets/prompts/`](src/yumii/assets/prompts/) —
copy one, rewrite the character, open a PR. Bigger leaps welcome:
new TTS/STT backends, tools, shells — see
[CONTRIBUTING.md](CONTRIBUTING.md).

## License

MIT — see [LICENSE](LICENSE). She's yours.
