# YAMS

YAMS is local-first, persistent memory for code, documents, and applications.
It combines content-addressed storage with text, vector, graph, and grep
retrieval.

> **Experimental:** YAMS is pre-1.0 and may change without compatibility
> guarantees.

## Start

Install with Homebrew, APT, DNF, pacman, Docker or the Windows MSI; see
[Install and setup](install.md).

```bash
brew install trvon/yams/yams
yams init
echo "hello world" | yams add - --tags demo
yams search hello
```

For MCP-compatible developer tools:

```bash
yams serve
```

```json
{
  "mcpServers": {
    "yams": {
      "command": "yams",
      "args": ["serve"]
    }
  }
}
```

## Reference

- [Install and setup](install.md): every channel, file locations, the daemon service, key settings
- [Build from source](BUILD.md)
- [P2P corpus sync](p2p.md)
- [Benchmarks](benchmarks/)
- [Runtime path authority](architecture/runtime-paths.md)
- [Configuration reading boundaries](architecture/config-reading.md)
- [Environment override policy](architecture/environment-overrides.md)
- [Roadmap](roadmap.md)
- [Newsletter](newsletter.md)
- [Contributing](https://github.com/trvon/yams/blob/main/CONTRIBUTING.md)

Command behavior is documented by `yams --help` and
`yams <command> --help`. Machine-readable interface contracts live with the
source.

## Project

- GitHub: <https://github.com/trvon/yams>
- Self-hosted mirror: <https://git.trevon.dev/trevon/yams>
- Discord: <https://discord.gg/rTBmRHdTEc>
- License: GPL-3.0-or-later