Skip to content

docs(hermes): install the adapter from the checkout — hermes-elephant is not on PyPI #33

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gigabyte22 merged 1 commit into from
Aug 7, 2026
Merged

docs(hermes): install the adapter from the checkout — hermes-elephant is not on PyPI #33

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ over the HTTP API above — the service is the source of truth.

| Adapter | Install | What it gives you |
|---|---|---|
| [`hermes`](adapters/hermes/hermes_elephant/provider/README.md) | `pip install hermes-elephant && hermes-elephant install` | A [hermes-agent](https://github.com/NousResearch/hermes-agent) memory provider: query-conditioned prefetch, non-blocking episode writes, pre-compression snapshots, subagent-delegation capture, and a `hermes elephant` CLI. Stdlib-only. |
| [`hermes`](adapters/hermes/hermes_elephant/provider/README.md) | `pip install ./adapters/hermes && hermes-elephant install` | A [hermes-agent](https://github.com/NousResearch/hermes-agent) memory provider: query-conditioned prefetch, non-blocking episode writes, pre-compression snapshots, subagent-delegation capture, and a `hermes elephant` CLI. Stdlib-only. |
| [`mcp`](adapters/mcp) | see its README | An MCP server exposing recall, facts, knowledge, procedures, and intentions as tools. |
| [`openclaw`](adapters/openclaw) | see its README | An OpenClaw plugin over the vendored TypeScript client. |

Expand Down
1 change: 1 addition & 0 deletions adapters/hermes/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@
__pycache__/
*.pyc
.pytest_cache/
dist/
16 changes: 12 additions & 4 deletions adapters/hermes/hermes_elephant/provider/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,12 +41,20 @@ docker compose up -d neo4j && pnpm migrate && pnpm serve

## Install

Not on PyPI yet — install from your elephant checkout, which you need anyway
for the service:

```bash
pip install hermes-elephant # into the hermes venv
hermes-elephant install
# into hermes's own venv, so it is already in place if entry-point
# discovery lands upstream
~/.hermes/hermes-agent/venv/bin/pip install ./adapters/hermes
~/.hermes/hermes-agent/venv/bin/hermes-elephant install
hermes memory setup # select 'elephant'
```

The installed provider is stdlib-only, so any Python can install the package —
the hermes venv is just the tidiest place for it.

### Why the second step

Hermes discovers memory providers by scanning directories — the bundled
Expand All @@ -70,8 +78,8 @@ hermes-elephant uninstall
HERMES_HOME=~/.hermes-work hermes-elephant install # a specific profile
```

Re-run `hermes-elephant install` after `pip install -U hermes-elephant`: the
upgrade replaces the package, but the copy already sitting in
Re-run `hermes-elephant install` after upgrading the package: the
upgrade replaces it, but the copy already sitting in
`$HERMES_HOME/plugins/elephant/` keeps running the old version until you do.
(`hermes update` does *not* require this — it rebuilds the install directory
and leaves `$HERMES_HOME` alone.)
Expand Down
Loading