memorybank
README.md
<a name="top"></a>
<div align="center">
<img src="https://capsule-render.vercel.app/api?type=rect&color=0:6b46c1,100:2b6cb0&height=120§ion=header&text=MEMORYBANK&fontSize=48&fontColor=ffffff&fontAlignY=58" width="100%" alt="MEMORYBANK"/>
# MEMORYBANK
### Portable long-term memory store for agents, exposed over MCP
<img src="https://readme-typing-svg.demolab.com?font=Fira+Code&size=18&duration=3500&pause=1000&color=6B46C1¢er=true&vCenter=true&width=720&lines=Portable+longterm+memory+store+for+agents+exposed+over+MCP;Self-hostable+%C2%B7+MCP-native+%C2%B7+CI-ready+%C2%B7+polyglot" width="720"/>
[](https://pypi.org/project/cognis-memorybank/) [](https://github.com/cognis-digital/memorybank/actions) [](LICENSE) [](https://github.com/cognis-digital)
*AI Agents & LLMOps โ build, route, evaluate, and secure agents.*
</div>
```bash
pip install cognis-memorybank
memorybank scan . # โ prioritized findings in seconds
```
<!-- cognis:example:start -->
## ๐ Example output
Real, reproducible output from the tool โ runs offline:
```console
$ memorybank-emit --version
memorybank 0.1.0
```
```console
$ memorybank-emit --help
usage: memorybank [-h] [--version] [--format {table,json}] [--path PATH]
{remember,recall,forget,list,stats} ...
Portable agent memory store.
positional arguments:
{remember,recall,forget,list,stats}
remember store a new memory
recall retrieve memories ranked by a query
forget delete a memory by id
list list every memory
stats show bank statistics
options:
-h, --help show this help message and exit
--version show program's version number and exit
--format {table,json}
--path PATH path to the JSONL memory bank
```
```console
$ memorybank-emit stats
{
"count": 0,
"halflife_days": 14.0,
"path": "C:\\Users\\user\\cognis-demo\\memorybank\\memorybank.jsonl",
"tags": {},
"total_accesses": 0
}
```
> Blocks above are real `memorybank` output โ reproduce them from a clone.
<!-- cognis:example:end -->
## Usage โ step by step
1. **Install** (Python 3.8+, stdlib only):
```bash
pip install memorybank
```
The store is a single JSONL file (default `memorybank.jsonl`, override with `--path` or `MEMORYBANK_PATH`).
2. **Remember** a fact, optionally tagged and weighted:
```bash
memorybank remember "User prefers metric units" --tag prefs --importance 2.0
```
3. **Recall** the most relevant memories for a query (ranked, recency-aware):
```bash
memorybank recall "what units?" --limit 5 --tag prefs
```
Add `--no-touch` to retrieve without updating recency.
4. **Read the output** โ every command emits JSON by default; switch to a human table:
```bash
memorybank --format table list
memorybank stats # bank-wide counts/metrics
memorybank forget <id> # delete one memory by id
```
5. **Drive it from an agent loop / CI** โ point each session at its own bank file:
```bash
export MEMORYBANK_PATH=./agent_state/memory.jsonl
memorybank recall "$TASK" --limit 8 | jq -r '.[].text'
```
Exits non-zero on error so callers can detect failures.
## Contents
- [Why memorybank?](#why) ยท [Features](#features) ยท [Quick start](#quick-start) ยท [Example](#example) ยท [Architecture](#architecture) ยท [AI stack](#ai-stack) ยท [How it compares](#how-it-compares) ยท [Integrations](#integrations) ยท [Install anywhere](#install-anywhere) ยท [Related](#related) ยท [Contributing](#contributing)
<a name="why"></a>
## Why memorybank?
agent-memory niche
`memorybank` is single-purpose, scriptable, and self-hostable: point it at a target, get prioritized results in the format your workflow already speaks (table ยท JSON ยท SARIF), gate CI on it, and let agents drive it over MCP.
<div align="right"><a href="#top">โ back to top</a></div>
<a name="features"></a>
## Features
- โ
Fast, single-purpose CLI
- โ
JSON / SARIF output for pipelines
- โ
CI fail-gate (`--fail-on`)
- โ
MCP server for AI agents
- โ
Runs on Linux/macOS/Windows ยท Docker ยท devcontainer
- โ
Ports in Python, JavaScript, Go, and Rust (`ports/`)
<div align="right"><a href="#top">โ back to top</a></div>
<a name="quick-start"></a>
## Quick start
```bash
pip install cognis-memorybank
memorybank --version
memorybank scan . # scan current project
memorybank scan . --format json # machine-readable
memorybank scan . --fail-on high # CI gate (non-zero exit)
```
<div align="right"><a href="#top">โ back to top</a></div>
<a name="example"></a>
## Example
```text
$ memorybank scan .
[HIGH ] MEM-001 example finding (./src/app.py)
[MEDIUM ] MEM-002 another signal (./config.yaml)
2 findings ยท risk score 5 ยท 38ms
```
<div align="right"><a href="#top">โ back to top</a></div>
<a name="architecture"></a>
## Architecture
```mermaid
flowchart LR
IN[MCP server] --> P[memorybank<br/>inspect]
P --> OUT[findings / policy]
```
<div align="right"><a href="#top">โ back to top</a></div>
<a name="ai-stack"></a>
## Use it from any AI stack
`memorybank` is interoperable with every popular way of using AI:
- **MCP server** โ `memorybank mcp` (Claude Desktop, Cursor, Cognis.Studio, [uncensored-fleet](https://github.com/cognis-digital/uncensored-fleet))
- **OpenAI-compatible / JSON** โ pipe `memorybank scan . --format json` into any agent or LLM
- **LangChain ยท CrewAI ยท AutoGen ยท LlamaIndex** โ wrap the CLI/JSON as a tool in one line
- **CI / scripts** โ exit codes + SARIF for non-AI pipelines
<div align="right"><a href="#top">โ back to top</a></div>
<a name="how-it-compares"></a>
## How it compares
| | **Cognis memorybank** | agent memory |
|---|:---:|:---:|
| Self-hostable, no account | โ
| varies |
| Single command, zero config | โ
| โ ๏ธ |
| JSON + SARIF for CI | โ
| varies |
| MCP-native (AI agents) | โ
| โ |
| Polyglot ports (JS/Go/Rust) | โ
| โ |
| Open license | โ
COCL | varies |
*Built in the spirit of **agent memory**, re-framed the Cognis way. Missing a credit? Open a PR.*
<div align="right"><a href="#top">โ back to top</a></div>
<a name="integrations"></a>
## Integrations
Pipes into your stack: **SARIF** for code-scanning, **JSON** for anything, an **MCP server** (`memorybank mcp`) for AI agents, and a webhook forwarder for SIEM/Slack/Jira. See [`docs/INTEGRATIONS.md`](docs/INTEGRATIONS.md).
<div align="right"><a href="#top">โ back to top</a></div>
<a name="install-anywhere"></a>
## Install โ every way, every platform
```bash
pip install "git+https://github.com/cognis-digital/memorybank.git" # pip (works today)
pipx install "git+https://github.com/cognis-digital/memorybank.git" # isolated CLI
uv tool install "git+https://github.com/cognis-digital/memorybank.git" # uv
pip install cognis-memorybank # PyPI (when published)
docker run --rm ghcr.io/cognis-digital/memorybank:latest --help # Docker
brew install cognis-digital/tap/memorybank # Homebrew tap
curl -fsSL https://raw.githubusercontent.com/cognis-digital/memorybank/main/install.sh | sh
```
| Linux | macOS | Windows | Docker | Cloud |
|---|---|---|---|---|
| `scripts/setup-linux.sh` | `scripts/setup-macos.sh` | `scripts/setup-windows.ps1` | `docker run ghcr.io/cognis-digital/memorybank` | [DEPLOY.md](docs/DEPLOY.md) (AWS/Azure/GCP/k8s) |
<div align="right"><a href="#top">โ back to top</a></div>
<a name="related"></a>
## Related Cognis tools
- [`agentsmith`](https://github.com/cognis-digital/agentsmith) โ Config-first scaffolding and orchestration for multi-agent workflows
- [`skillhub`](https://github.com/cognis-digital/skillhub) โ Local skill registry and installer for AI agents
- [`toolguard`](https://github.com/cognis-digital/toolguard) โ Runtime allowlist and policy for agent tool-calls
- [`evalbench`](https://github.com/cognis-digital/evalbench) โ Offline LLM / agent eval harness with regression gates
- [`ragkit`](https://github.com/cognis-digital/ragkit) โ Batteries-included local RAG pipeline โ ingest, index, serve
- [`promptpack`](https://github.com/cognis-digital/promptpack) โ Versioned prompt / template registry with A/B and rollbacks
**Explore the suite โ** [๐๏ธ all 170+ tools](https://github.com/cognis-digital/cognis-neural-suite) ยท [โญ awesome-cognis](https://github.com/cognis-digital/awesome-cognis) ยท [๐ cognis-sources](https://github.com/cognis-digital/cognis-sources) ยท [๐ค uncensored-fleet](https://github.com/cognis-digital/uncensored-fleet) ยท [๐ง engram](https://github.com/cognis-digital/engram)
<div align="right"><a href="#top">โ back to top</a></div>
<a name="contributing"></a>
## Contributing
PRs, new rules, and demo scenarios are welcome under the collaboration-pull model โ see [CONTRIBUTING.md](CONTRIBUTING.md) and [SECURITY.md](SECURITY.md).
> ### โญ If `memorybank` saved you time, **star it** โ it genuinely helps others find it.
## Interoperability
`{}` composes with the 300+ tool Cognis suite โ JSON in/out and a shared
OpenAI-compatible `/v1` backbone. See **[INTEROP.md](INTEROP.md)** for the
suite map, composition patterns, and reference stacks.
## License
Source-available under the **Cognis Open Collaboration License (COCL) v1.0** โ free for personal, internal-evaluation, research, and educational use; **commercial / production use requires a license** (licensing@cognis.digital). See [LICENSE](LICENSE).
---
<div align="center"><sub><b><a href="https://cognis.digital">Cognis Digital</a></b> ยท one of 170+ tools in the <a href="https://github.com/cognis-digital/cognis-neural-suite">Cognis Neural Suite</a> ยท <i>Making Tomorrow Better Today</i></sub></div>
This server cannot be deployed
Maintenance
ActivityStale
ResponsivenessNo issues