Metadata-Version: 2.4
Name: colonymind
Version: 1.0.0
Summary: A mind for Hermes agents: persistent memory, commitments, initiative and measured autonomy
License-Expression: MIT
Project-URL: Homepage, https://aevonix.com/colonymind
Project-URL: Repository, https://github.com/Aevonix/ColonyMind
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: <3.14,>=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: fastapi>=0.110
Requires-Dist: uvicorn[standard]>=0.29
Requires-Dist: litellm>=1.40
Requires-Dist: pydantic>=2.6
Requires-Dist: PyYAML>=6.0
Requires-Dist: aiosqlite>=0.19
Requires-Dist: httpx>=0.27
Requires-Dist: websockets>=12.0
Requires-Dist: Pillow>=10.0
Requires-Dist: cryptography>=42.0
Requires-Dist: pypdf<7,>=6.18.0
Requires-Dist: psutil<8,>=7.2.2; sys_platform == "darwin"
Requires-Dist: lancedb>=0.30.2
Requires-Dist: pyarrow>=15.0
Requires-Dist: pandas>=2.0
Provides-Extra: vectors
Requires-Dist: sentence-transformers>=3.0; extra == "vectors"
Requires-Dist: transformers>=4.51.0; extra == "vectors"
Provides-Extra: hermes
Requires-Dist: colonymind-hermes<2,>=1.0.0; extra == "hermes"
Provides-Extra: video
Requires-Dist: av==18.1.0; extra == "video"
Provides-Extra: dev
Requires-Dist: av==18.1.0; extra == "dev"
Requires-Dist: psutil<8,>=7.2.2; extra == "dev"
Requires-Dist: sentence-transformers>=3.0; extra == "dev"
Requires-Dist: transformers>=4.51.0; extra == "dev"
Requires-Dist: pandas>=2.0; extra == "dev"
Requires-Dist: pyarrow>=15.0; extra == "dev"
Requires-Dist: lancedb>=0.30.2; extra == "dev"
Requires-Dist: pytest>=8.0; extra == "dev"
Requires-Dist: pytest-timeout>=2.3; extra == "dev"
Requires-Dist: pytest-asyncio>=0.23; extra == "dev"
Requires-Dist: hypothesis>=6.100; extra == "dev"
Requires-Dist: httpx>=0.27; extra == "dev"
Requires-Dist: jsonschema>=4.21; extra == "dev"
Dynamic: license-file

# ColonyMind

**A mind for Hermes agents: persistent memory, commitments, initiative and measured autonomy.**

Not just remember: keep promises and take the next step, within limits the owner sets. ColonyMind gives a personal
[Hermes](https://github.com/NousResearch/hermes-agent) agent memory across sessions and channels in people's own
words, commitments it keeps, people it knows, and a small mind that acts on its own inside an autonomy level, budgets
and quiet hours the owner sets. Asks reach the owner as plain messages, answered with a plain yes, a reply or a
thumbs-up; the model can never approve anything.

This package is the ColonyMind sidecar and its `colonymind` command. It attaches to stock Hermes through the companion
`colonymind-hermes` adapter, which `colonymind init` installs into Hermes' own environment; the sidecar runs in an
environment of its own. No fork, no patches, no graph database, no extra key.

## Install

You need Python 3.11 to 3.13 (3.12 recommended), a stock Hermes install (`hermes-agent >=0.21.3,<0.24`) whose
`hermes` executable is on `PATH`, and one OpenAI-compatible chat endpoint, which Hermes already has.

```bash
uv tool install --python 3.12 colonymind
colonymind init
hermes gateway restart
```

pipx works too (`pipx install --python python3.12 colonymind`). ColonyMind becomes Hermes' memory provider: `init`
names the provider it replaces, and `colonymind init --uninstall` puts it back. `colonymind doctor` checks the install,
and `colonymind demo` shows the loop with no model, no keys and no network: a fact recalled across sessions, a
promise followed up on its own, and an ask the person answers in plain words.

One container runs stock Hermes and ColonyMind together: `ghcr.io/aevonix/colonymind`, stock Hermes' own published
image pinned by digest and patched nowhere
([the container guide](https://github.com/Aevonix/ColonyMind/blob/main/docs/INSTALL.md#container)).

The vector store (LanceDB) is part of every install: semantic recall needs only an OpenAI-compatible embeddings
endpoint (`colonymind init --embed-url auto` looks for one on the model endpoint). Where the endpoint has none, the
`vectors` extra lets the sidecar run a pinned embedding model itself
(`uv tool install --force --python 3.12 'colonymind[vectors]'`, which brings PyTorch, then
`colonymind init --embed-url local`, which downloads the model once into the instance directory).

To update: `uv tool upgrade colonymind` (or `pipx upgrade colonymind`), `colonymind upgrade`, `hermes gateway restart`.

## Learn more

- [Project README](https://github.com/Aevonix/ColonyMind/blob/main/README.md): what works, the evidence against stock
  Hermes, and what is not yet demonstrated.
- What memory holds about a person, with each claim's history:
  [the memory inventory](https://github.com/Aevonix/ColonyMind/blob/main/docs/SOURCE-ANNOTATIONS.md#the-memory-inventory);
  what the model calls cost:
  [usage by lane](https://github.com/Aevonix/ColonyMind/blob/main/docs/FUNCTION-ROUTING.md#usage-model-calls-by-lane).
- [Install and update](https://github.com/Aevonix/ColonyMind/blob/main/docs/INSTALL.md): what `colonymind init`
  changes, configuration, the sidecar service, updating and uninstalling.
- [Documentation index](https://github.com/Aevonix/ColonyMind/blob/main/docs/README.md),
  [troubleshooting](https://github.com/Aevonix/ColonyMind/blob/main/docs/TROUBLESHOOTING.md) and the
  [changelog](https://github.com/Aevonix/ColonyMind/blob/main/CHANGELOG.md).

Licensed under the included MIT license. Optional dependencies retain their own licenses.
