Metadata-Version: 2.3
Name: remedy-ai
Version: 0.18.5
Summary: Self-improving multi-channel software coding agent framework (memory, learning, tools) — not a medical product
Keywords: ai,agent,framework,skill,memory,learning,llm,tools
Author: Ahmi Darrow
Author-email: Ahmi Darrow <ahmitdarrow@gmail.com>
License: LicenseRef-Proprietary
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Requires-Dist: aiohttp>=3.14.2
Requires-Dist: fastapi>=0.139.2
Requires-Dist: packaging>=24.0
Requires-Dist: pydantic>=2.13.4
Requires-Dist: python-multipart>=0.0.9
Requires-Dist: pyyaml>=6.0.3
Requires-Dist: pynacl>=1.5.0
Requires-Dist: rich>=15.0.0
Requires-Dist: uvicorn>=0.51.0
Requires-Dist: pyinstaller>=6.21.0 ; extra == 'desktop-build'
Requires-Dist: fastapi>=0.139.2 ; extra == 'server'
Requires-Dist: uvicorn>=0.51.0 ; extra == 'server'
Requires-Dist: python-multipart>=0.0.9 ; extra == 'server'
Requires-Python: >=3.12
Project-URL: Homepage, https://github.com/AhmiDarrow/RemedyAI
Project-URL: Repository, https://github.com/AhmiDarrow/RemedyAI
Provides-Extra: desktop-build
Provides-Extra: server
Description-Content-Type: text/markdown

# Remedy

**Your personal AI partner — on your machine.**

Knowledge, design, code, and get-it-done work. One continuous partner — not a thin chat wrapper, not a farm of bots.  
**Not** a medical product; the name means unsticking problems and finishing requests.

**[Download latest for Windows](https://github.com/AhmiDarrow/RemedyAI/releases/latest)** · **[Owner’s manual (GitHub)](https://github.com/AhmiDarrow/RemedyAI/blob/master/docs/manual/00-overview.md)** · **F1** in-app

---

## Contents

1. [What you get](#what-you-get) — product at a glance  
2. [Why it’s different](#why-its-different) — local continuity  
3. [Workspace on your PC](#workspace-on-your-pc) — files, terminal, browser, scratch  
4. [Local brain (Qwen)](#local-brain-qwen) — vision + efficiency without a second persona  
5. [Continuity workers](#continuity-workers) — silent nano swarm  
6. [Messengers](#messengers) — chat where you already are  
7. [Skills & Library](#skills--library)  
8. [Memory & long work](#memory--long-work)  
9. [Install](#install)  
10. [Security](#security)  
11. [Slash commands](#slash-commands)  
12. [Architecture](#architecture)  
13. [CLI & API](#cli--api)  
14. [Development](#development)  
15. [Support](#support) · [License](#license)  

### Owner’s manual (hosted on GitHub)

GitHub renders the full Help wiki as markdown (same chapters as in-app **F1**):

| | |
|--|--|
| **Start here** | [Overview](https://github.com/AhmiDarrow/RemedyAI/blob/master/docs/manual/00-overview.md) |
| **All chapters** | [docs/manual/](https://github.com/AhmiDarrow/RemedyAI/tree/master/docs/manual) · [chapter index](https://github.com/AhmiDarrow/RemedyAI/blob/master/docs/manual/README.md) |
| **Continuity** | [How Remedy works](https://github.com/AhmiDarrow/RemedyAI/blob/master/docs/manual/16-continuity-philosophy.md) |
| **Local Qwen** | [Vision & on-device Qwen](https://github.com/AhmiDarrow/RemedyAI/blob/master/docs/manual/14-visual-decoder.md) |
| **Chat & rails** | [Chat & sessions](https://github.com/AhmiDarrow/RemedyAI/blob/master/docs/manual/05-chat-and-sessions.md) |
| **Skills** | [Skills](https://github.com/AhmiDarrow/RemedyAI/blob/master/docs/manual/07-skills.md) |
| **What’s new** | [What’s new](https://github.com/AhmiDarrow/RemedyAI/blob/master/docs/manual/13-whats-new.md) |

Also: [CHANGELOG.md](CHANGELOG.md) · [AGENTS.md](AGENTS.md)

---

## What you get

One desktop app. One local API. Your data under `~/.remedy`.

| | Capability |
|--|------------|
| **Chat partner** | Streaming markdown, Plan/Build, attachments, image markup, stick-to-bottom feed |
| **Workspace** | **Files** · **Terminal** (PowerShell) · **Browser** (embedded WebView2) · **Scratch** pad — rails beside chat |
| **Local brain** | **Qwen2.5-VL 3B** on this PC — visual decoder + harness assist (optional download) |
| **Continuity** | Session Brief, memory, skills, context budget — silent workers, one voice |
| **Messengers** | Telegram, Discord, Slack, Mattermost, Matrix, WhatsApp, Teams, Google Chat, Signal (Settings) |
| **Skills** | Learn from real work · **Installed \| Library** · signed community catalog |
| **Memory** | Durable facts · Progress snapshots · plans — calm UI, not scare-logs |
| **Agency** | `file_edit`, repo search, missions, approvals (Ask default / Auto when you want) |
| **Web UI** | Same SPA at `http://127.0.0.1:7400/` (Switch to WebUI → tray) |
| **Updates** | Minisign-signed auto-update from GitHub Releases |

Your **chat model** is yours: xAI, OpenAI, Anthropic, Google, DeepSeek, Groq, Mistral, OpenRouter, **Ollama**, or Custom. Continuity and local Qwen live **on disk**, not in a Remedy cloud.

---

## Why it’s different

```text
You  →  Continuity (brief · memory · skills · budget · local Qwen)  →  Your model  →  Tools
              ↑________________ learn / compress / remember ________________|
```

| You feel | What’s actually happening |
|----------|---------------------------|
| **Fast** | Hot path stays cheap; heavy work is background |
| **Cheaper** | Less tool sludge re-sent; Qwen where it saves paid calls |
| **Same partner** | Switch providers anytime — identity is local |

Deep dive: [Continuity philosophy](docs/manual/16-continuity-philosophy.md) · In-app **F1**.

---

## Workspace on your PC

Remedy is a **workbench**, not only a chat box. Icon rails open real tools next to the conversation:

| Tool | What it is |
|------|------------|
| **Files** | Project / session file browser — open, copy path, drag into chat |
| **Terminal** | In-app **PowerShell** (ConPTY) — same machine the agent can work on |
| **Browser** | Embedded **WebView2** (Chromium) research pane; **↗** opens system browser when you need full Chrome |
| **Scratch** | Quick notes pad bound to the session |

Left · chat · right layout; popout / fullscreen for Terminal, Browser, Scratch.  
Manual: [Chat & sessions](docs/manual/05-chat-and-sessions.md) · [Desktop notes](docs/DESKTOP.md)

---

## Local brain (Qwen)

**On-device efficiency** — not a second chatbot.

| Job | Local **Qwen2.5-VL 3B** |
|-----|-------------------------|
| **Visual decoder** | Images → structured text briefs so **any** chat model can reason about screenshots |
| **Prefer-local vision** | Decode here first; save provider vision tokens when you want |
| **Harness assist** | Session Brief can refresh in the background without another paid API call |
| **Continuity assist** | Optional nano refine when the server is already up (never blocks the hot path) |

**How it ships:** not in the installer → one first-run download → `~/.remedy/vision/` → **llama-server** on **127.0.0.1** → auto-starts with Remedy. CPU by default; CUDA when NVIDIA is available.

Manual: [Local vision & on-device Qwen](docs/manual/14-visual-decoder.md)

---

## Continuity workers

Silent local workers (sometimes called the **nano swarm** in code). They measure, prune, rank, and distill. They **do not** take the microphone.

| Worker | Job |
|--------|-----|
| Token | Context fill, compress nudge, usage calibration |
| Router | Intent → policy (memory / skill / plan / tool / chat) |
| Memory | Session Brief touch |
| Pattern | Tool sequences, stuck signals, learn pre-gate |
| Skill | Ranking and feedback for procedures |

Heuristics first; local Qwen only when already running and useful.  
Operators: [Continuity workers](docs/manual/17-nanoswarm.md) · `/harness`

---

## Messengers

Talk to Remedy where you already chat. Sessions show up in the desktop list (e.g. `TG · …`) with shared history.

| Platform | Status (catalog) |
|----------|------------------|
| **Telegram** | Ready — long-poll bot (allowlist recommended) |
| **Discord · Slack · Mattermost · Matrix** | Ready adapters |
| **WhatsApp · Teams · Google Chat · Signal** | Partial (webhooks / signal-cli / setup-dependent) |

Configure under **Settings → Messengers**. Empty allowlist = ignore inbound (unless you allow all).  
Security defaults stay local-first: no public doorway by accident.

---

## Skills & Library

| Path | Meaning |
|------|---------|
| **Learn from work** | Multi-step success → probation skills → promote over sessions |
| **Installed** | Bundled + learned + trusted library packs on this machine |
| **Library** | Signed community catalog ([remedy-skills](https://github.com/AhmiDarrow/remedy-skills)) — install → quarantine → **Trust** |

Format: [agentskills.io](https://agentskills.io) · Lifecycle: [SKILL_LIFECYCLE.md](docs/SKILL_LIFECYCLE.md) · Manual: [Skills](docs/manual/07-skills.md)

---

## Memory & long work

- **Durable memory** — SQLite + FTS5, profile, handoffs  
- **Memory Harness** — lean *send-view* for the model; full transcript kept  
- **Progress** — mid-task snapshots (calm wording: progress, not “the app crashed”)  
- **Plans** — Plan mode outlines; Build executes with approvals  
- **Time travel** — restore chat (+ best-effort files) to an earlier step  

`/compact` · `/harness` · [Memory manual](docs/manual/06-memory-and-harness.md)

---

## Install

1. [Download the **latest** Windows installer](https://github.com/AhmiDarrow/RemedyAI/releases/latest)  
2. Run Setup → provider + optional workspace + optional local vision  
3. **F1** Help · `/help` commands  

> **SmartScreen?** Solo builds are not Authenticode-signed yet — **More info → Run anyway**. Install only from this repo’s Releases. Updates are **minisign**-verified. Autostart = Startup folder (not registry Run).

Local API: **127.0.0.1:7400** (sidecar).

---

## Security

**Maximum capability for you. No accidental LAN doorway.**

| Layer | Default |
|-------|---------|
| API | Loopback + Bearer token |
| CORS | No wildcard while auth is on |
| Secrets | `~/.remedy/auth/` (DPAPI on Windows when available) |
| Scope | Project / home / full machine (opt-in) |
| Approvals | **Ask** default |
| Skills | Quarantine until Trust |
| Messengers | Allowlist-first |

No Remedy cloud account for core use. Chat goes to **your** provider (or local Ollama).  
[Security & data](docs/manual/04-security-and-data.md)

---

## Slash commands

| | |
|--|--|
| `/help` · `/new` · `/sessions` · `/models` · `/thinking` | Session & UI |
| `/memory` · `/remember` · `/forget` · `/pin` · `/whoami` | Memory |
| `/goals` · `/goal` · `/plans` · `/plan` … | Plans |
| `/compact` · `/harness` | Harness |
| `/approve` · `/deny` | Approvals |
| `/export` · `/import` · `/import-session` | I/O |
| `/skills` · `/handoff` · `/init` · `/helper` · `/tip` | Skills & tips |

Full list: [Commands](docs/manual/11-reference-commands.md)

---

## Architecture

```text
┌─ Desktop (Tauri 2) ─────────────────────────────────────┐
│  React SPA · tray · updates · Files/Terminal/Browser   │
│              │                                           │
│  remedy serve · FastAPI :7400                            │
│    gateway · core · memory · skills · vision (Qwen)      │
└──────────────────────────────────────────────────────────┘
     CLI · WebUI · Telegram · Discord · Slack · …
```

---

## CLI & API

```bash
# Package name on PyPI is remedy-ai
pip install remedy-ai

remedy chat
remedy serve --host 127.0.0.1 --port 7400 --skip-setup
# Web UI http://127.0.0.1:7400/  ·  /docs  ·  /dashboard
```

WebUI is the **same SPA** as desktop (`desktop/dist`). After UI changes:  
`cd desktop && npm run build`, then restart serve if needed — see [AGENTS.md](AGENTS.md) (*Desktop SPA vs WebUI*).

---

## Development

```bash
git clone https://github.com/AhmiDarrow/RemedyAI.git && cd RemedyAI
uv sync --group dev
uv run pytest -q          # 560+ tests; currently ~930
cd desktop && npm test && npm run build
python scripts/check_docs.py
cd desktop && npm run tauri:dev   # full shell (set REMEDY_DEV_ROOT to repo)
```

Release: `python scripts/sync_version.py X.Y.Z` · `python scripts/sync_help_manual.py` · `python scripts/check_docs.py` · tag `vX.Y.Z` · GitHub Actions.  
Signing: [AGENTS.md](AGENTS.md) · [WINDOWS_SIGNING.md](docs/WINDOWS_SIGNING.md)

---

## Support

[patreon.com/cw/AhmiDarrow](https://www.patreon.com/cw/AhmiDarrow) — thank you.

---

## License

**Source-available** — [LICENSE](./LICENSE) · [COMMERCIAL.md](./COMMERCIAL.md)

| Who | Terms |
|-----|--------|
| Solo / small indies (&lt; $1M revenue **and** &lt; 20 FTE) | Free under LICENSE |
| Personal / education / research | Free |
| Larger orgs, SaaS, commercial resale | Written license — **ahmitdarrow@gmail.com** |

Copyright © 2025–2026 **Ahmi Darrow**.

---

*My name is Ahmi, I hope you enjoy my Remedy.*
