Metadata-Version: 2.4
Name: heropen
Version: 1.8.9
Summary: heropen — AI Agent Long-term Memory System
Project-URL: Homepage, https://heropen.net
Project-URL: Documentation, https://heropen.net/heropen/docs/
Project-URL: Repository, https://github.com/Koradji77/heropen
Author-email: KSMN Studio <akoken@163.com>
License: Apache-2.0
License-File: LICENSE
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.10
Provides-Extra: all
Requires-Dist: fastembed>=0.6; extra == 'all'
Requires-Dist: mcp>=1.6; extra == 'all'
Requires-Dist: rich>=13.0; extra == 'all'
Provides-Extra: embedding
Requires-Dist: fastembed>=0.6; extra == 'embedding'
Provides-Extra: ui
Requires-Dist: rich>=13.0; extra == 'ui'
Description-Content-Type: text/markdown

# heropen

> Give your AI agent long-term memory. Data stays on your machine; search costs zero tokens.

## Why "heropen"

The name comes from two places: **her** from Hermes (the agent you are reading this with), **open** from OpenClaw (openness). her + open put together is heropen.

Written out, heropen starts with **hero** — evoking the Marvel superhero trope. It is a memory layer that remembers you and writes things down for your agent.

## Install

```bash
pip install heropen
```

Restart your agent. That's it.

On first launch it auto-detects your agent (Claude Code, Cursor, Windsurf, or any MCP client), sets up the database, and registers the memory tools. Your agent will notice the new install and walk you through setup.

## 30-second quickstart

```bash
# Save a memory
heropen add "Project uses FastAPI + SQLAlchemy, tests with pytest"

# Search memories
heropen search "project tech stack"

# Check status
heropen status

# Diagnose issues
heropen diagnose
```

## Connect your agent (MCP)

Works with any MCP-compatible agent. v1.8+ auto-detects and configures — no manual steps.

Or add it manually to your agent config:

```json
{
  "mcpServers": {
    "heropen": {
      "command": "heropen",
      "args": ["mcp"]
    }
  }
}
```

Restart your agent and it has memory. Store a bug fix once, remember it permanently across sessions.

## Privacy promise

**Data stays on your machine. No telemetry. No heartbeat pings.** All memory is stored in a local SQLite database. Vector search uses a **local embedding model by default** (fastembed, `pip install heropen[embedding]`) — fully offline, zero cost. Optionally, you can point it at **your own self-hosted embedding endpoint** by setting the `EMBEDDING_ENDPOINT` and `EMBEDDING_API_KEY` environment variables (OpenAI-compatible `/v1/embeddings`), so no third-party cloud is ever billed. Memory text is only used to generate vectors and is never reported.

If neither a local embedding model nor a self-hosted endpoint is configured, search automatically degrades to fast full-text (FTS) matching — still fully offline and zero cost. So `pip install heropen` works with **zero setup**; embeddings only *upgrade* search quality, they never gate basic use.

## Open-source scope

The free edition is fully open source (Apache-2.0). The commercial layer (Plus / Enterprise) is closed source.

## Why heropen

| | heropen (free) | other solutions |
|---|---|---|
| Storage | unlimited | usually capped |
| Searches | unlimited | pay per query |
| Needs network | no | yes |
| Data ownership | your machine | their servers |
| Install | one `pip install` | server + config |

Free = full core features. No crippled functionality.

## Links

- Home: [heropen.net](https://heropen.net)
- Docs: [heropen.net/heropen/docs](https://heropen.net/heropen/docs)
- GitHub: [github.com/Koradji77/heropen](https://github.com/Koradji77/heropen)

## License

Apache-2.0
