yams/docs/index.md

YAMS — Yet Another Memory System

$ yams --version
YAMS: persistent memory for LLMs and applications
SHA-256 CAS • Rabin dedupe • zstd/LZMA • FTS5 + vectors • WAL

Persistent memory for LLMs and applications. Content‑addressed storage with deduplication, compression, semantic search, and full‑text indexing.

What it does

• Content‑addressed storage (SHA‑256)
• Block‑level deduplication (Rabin fingerprinting)
• Compression: zstd and LZMA
• Search: full‑text (SQLite FTS5) + semantic (vector)
• Crash safety: WAL
• Fast and portable CLI + MCP server

Install

Quick install (prebuilt binaries):

curl -fsSL https://raw.githubusercontent.com/trvon/yams/main/install.sh | bash

Docker:

docker run --rm -it ghcr.io/trvon/yams:latest --version

From source (Conan): see Get Started → Installation.

Quick start

# init storage (non-interactive)
yams init --non-interactive

# store from stdin
echo "hello world" | yams add - --tags example

# search
yams search "hello" --json

# retrieve
yams list --format minimal --limit 1 | xargs yams get

Docs

• Get Started: Installation, CLI, and prompts
• Usage: Search guide, vector search, tutorials
• API: REST/OpenAPI, MCP tools
• Architecture: search and vector systems
• Developer/Operations/Admin: build, deploy, configure, tune

Use the left navigation to browse all docs.

Links

• GitHub: https://github.com/trvon/yams
• License: Apache-2.0