Metadata-Version: 2.4
Name: cremind
Version: 0.0.1
Summary: Cremind — open personal assistant server and CLI
Project-URL: Homepage, https://github.com/cremind-ai/cremind
Project-URL: Issues, https://github.com/cremind-ai/cremind/issues
Author: Cremind contributors
License: MIT
License-File: LICENSE
Classifier: Environment :: Console
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Communications :: Chat
Requires-Python: >=3.13.9
Requires-Dist: a2a-sdk[http-server,sql]<1.0,>=0.3.10
Requires-Dist: aiosqlite>=0.21.0
Requires-Dist: alembic>=1.13.0
Requires-Dist: dynaconf>=3.2.0
Requires-Dist: fastmcp>=2.12.5
Requires-Dist: httpx-sse>=0.4
Requires-Dist: httpx[http2]>=0.27
Requires-Dist: jinja2>=3.1.6
Requires-Dist: jsonschema>=4.23.0
Requires-Dist: loguru>=0.7.3
Requires-Dist: prompt-toolkit>=3.0.47
Requires-Dist: pydantic>=2.12.3
Requires-Dist: pyjwt>=2.8.0
Requires-Dist: python-dotenv>=1.1.1
Requires-Dist: python-multipart>=0.0.9
Requires-Dist: pywinpty>=2.0; sys_platform == 'win32'
Requires-Dist: pyyaml>=6.0
Requires-Dist: qrcode>=7
Requires-Dist: rich>=13
Requires-Dist: starlette<1.0,>=0.52.1
Requires-Dist: tenacity>=8.2.0
Requires-Dist: toml>=0.10.2
Requires-Dist: typer>=0.12
Requires-Dist: uvicorn>=0.41.0
Requires-Dist: watchdog>=4.0.0
Requires-Dist: websockets>=13.0
Provides-Extra: all
Requires-Dist: anthropic>=0.52.0; extra == 'all'
Requires-Dist: asyncpg>=0.29; extra == 'all'
Requires-Dist: chromadb>=0.5.0; extra == 'all'
Requires-Dist: google-api-python-client>=2.0.0; extra == 'all'
Requires-Dist: google-auth>=2.0.0; extra == 'all'
Requires-Dist: groq>=0.33.0; extra == 'all'
Requires-Dist: markitdown[all]>=0.1.0; extra == 'all'
Requires-Dist: openai>=2.6.0; extra == 'all'
Requires-Dist: pandas>=3.0.1; extra == 'all'
Requires-Dist: playwright>=1.52.0; extra == 'all'
Requires-Dist: psycopg[binary]>=3.1; extra == 'all'
Requires-Dist: python-telegram-bot>=21.0; extra == 'all'
Requires-Dist: qdrant-client>=1.9.0; extra == 'all'
Requires-Dist: sentence-transformers>=3.0.0; extra == 'all'
Requires-Dist: telethon>=1.36.0; extra == 'all'
Requires-Dist: tiktoken>=0.12.0; extra == 'all'
Provides-Extra: browser
Requires-Dist: playwright>=1.52.0; extra == 'browser'
Provides-Extra: channel-telegram-bot
Requires-Dist: python-telegram-bot>=21.0; extra == 'channel-telegram-bot'
Provides-Extra: channel-telegram-userbot
Requires-Dist: telethon>=1.36.0; extra == 'channel-telegram-userbot'
Provides-Extra: documents
Requires-Dist: markitdown[all]>=0.1.0; extra == 'documents'
Requires-Dist: pandas>=3.0.1; extra == 'documents'
Provides-Extra: embeddings-gemma
Requires-Dist: pandas>=3.0.1; extra == 'embeddings-gemma'
Requires-Dist: sentence-transformers>=3.0.0; extra == 'embeddings-gemma'
Provides-Extra: embeddings-me5
Requires-Dist: pandas>=3.0.1; extra == 'embeddings-me5'
Requires-Dist: sentence-transformers>=3.0.0; extra == 'embeddings-me5'
Provides-Extra: google
Requires-Dist: google-api-python-client>=2.0.0; extra == 'google'
Requires-Dist: google-auth>=2.0.0; extra == 'google'
Provides-Extra: llm-anthropic
Requires-Dist: anthropic>=0.52.0; extra == 'llm-anthropic'
Provides-Extra: llm-groq
Requires-Dist: groq>=0.33.0; extra == 'llm-groq'
Requires-Dist: tiktoken>=0.12.0; extra == 'llm-groq'
Provides-Extra: llm-openai
Requires-Dist: openai>=2.6.0; extra == 'llm-openai'
Requires-Dist: tiktoken>=0.12.0; extra == 'llm-openai'
Provides-Extra: postgres
Requires-Dist: asyncpg>=0.29; extra == 'postgres'
Requires-Dist: psycopg[binary]>=3.1; extra == 'postgres'
Provides-Extra: tokenization
Requires-Dist: tiktoken>=0.12.0; extra == 'tokenization'
Provides-Extra: vectorstore-chroma
Requires-Dist: chromadb>=0.5.0; extra == 'vectorstore-chroma'
Provides-Extra: vectorstore-qdrant
Requires-Dist: qdrant-client>=1.9.0; extra == 'vectorstore-qdrant'
Description-Content-Type: text/markdown

# Cremind

Open personal assistant — server, desktop app, and CLI you run yourself.

[![PyPI](https://img.shields.io/pypi/v/cremind.svg)](https://pypi.org/project/cremind/)
[![Python](https://img.shields.io/badge/python-%E2%89%A53.13-blue.svg)](https://www.python.org/downloads/)
[![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](#license)
[![CI](https://github.com/cremind-ai/cremind/actions/workflows/pr.yml/badge.svg)](https://github.com/cremind-ai/cremind/actions/workflows/pr.yml)

## What is Cremind?

Cremind is a personal AI assistant that runs on your own machine or server. It
bundles a multi-profile agent runtime, a tool plane, a web UI, and a CLI into
one package. Profiles isolate personas, LLM keys, skills, and conversations,
so the same install can host a work assistant, a coding assistant, and a
home assistant side by side without bleeding context across them.

Under the hood, Cremind speaks two open protocols: **A2A** for pluggable agents
and **MCP** for pluggable tools. Bring your own LLM (Anthropic, OpenAI, Groq),
plug in any MCP server, and reach the assistant through whichever surface
fits — browser, desktop app, terminal, or a chat channel like Telegram.

## Features

- **Multi-profile agents** with isolated personas, skills, browser profiles, and conversation history.
- **Pluggable LLMs** — Anthropic, OpenAI, and Groq, installed on demand via feature flags.
- **Tool plane** — built-in file browser, terminal, document RAG, and Playwright browser automation; add any MCP server.
- **Document ingestion** — drop files in a watched folder; Cremind indexes them for retrieval.
- **Storage that scales with you** — SQLite by default; switch any service to Postgres, Qdrant, or ChromaDB as a Docker sidecar or external endpoint, from the Setup Wizard.
- **Chat channels** — Telegram bot and userbot adapters included; channel API for adding more.
- **Three surfaces** — Web UI at `:1515`, the **Cremind App** desktop client (Windows / macOS / Linux), and an `cremind` CLI for chat, conversations, tools, and admin.
- **Cross-platform** — runs on Linux, macOS, and Windows; sandboxed Docker mode available for stronger isolation.

## Install

### Cremind App (desktop)

Download the prebuilt installer for your OS from the
[Releases page](https://github.com/cremind-ai/cremind/releases):

| OS      | File |
|---------|------|
| Windows | `Cremind App-Windows-<version>-Setup.exe` (NSIS) |
| macOS   | `Cremind App-macOS-<version>.dmg`               |
| Linux   | `Cremind App-Linux-<version>.AppImage`          |

The desktop app auto-updates from GitHub Releases and bundles the agent — no
separate server install needed.

### One-line install (Linux / macOS)

```bash
curl -fsSL https://cremind.io/install.sh | bash
```

Or fetch the same script straight from GitHub:

```bash
curl -fsSL https://raw.githubusercontent.com/cremind-ai/cremind/main/install/install.sh | bash
```

### One-line install (Windows)

```powershell
iwr -useb https://cremind.io/install.ps1 | iex
```

Or fetch the same script straight from GitHub:

```powershell
iwr -useb https://raw.githubusercontent.com/cremind-ai/cremind/main/install/install.ps1 | iex
```

The installer detects Docker and asks which mode to use:

- **Docker** *(recommended)* — agent runs in a sandboxed XFCE container with
  VNC at `:6080`. Postgres / Qdrant / ChromaDB activate as sibling
  containers on demand.
- **Native** — Python 3.13+ venv at `~/.cremind/venv`, SQLite, agent shares
  your desktop.

Both modes are idempotent — re-running upgrades in place. See
[`install/README.md`](install/README.md) for the full flag reference and
deployment-type options (`local` / `server` / `custom`).

## First run

1. Wait for the installer to finish (it pulls images or builds a venv, runs migrations, and starts the server).
2. Your browser opens automatically to **`http://<host>:1515/#/setup`** — the Setup Wizard.
3. Pick an LLM provider, paste an API key, create your first profile, and you're chatting.

Prefer the terminal? `cremind chat` gives you a streamed REPL against the same
profile. `cremind --help` lists every command (profiles, conversations, tools,
agents, channels, LLM config, …).

## Requirements

- **Docker mode**: Docker Engine with Compose v2. Any OS.
- **Native mode**: Python **3.13.9+** on Linux, macOS, or Windows.

## Documentation

- [`install/README.md`](install/README.md) — installer reference, flags, deployment types, and file layout.
- [`CONTRIBUTING.md`](CONTRIBUTING.md) — development setup and contribution workflow.
- [`RELEASING.md`](RELEASING.md) — release channels (production / test / dev) and the release process.
- In-app docs live under [`documents/`](documents/) and are auto-indexed for retrieval.

## License

MIT.
