# YAMS Documentation

Content-addressed storage with deduplication and semantic search.

## Quick Start

- [Installation](user_guide/installation.md) - Setup YAMS
- [CLI Guide](user_guide/cli.md) - Command reference
- [API Docs](api/README.md) - Integration reference
- [Examples](user_guide/tutorials/README.md) - Usage examples

## User Docs

- [Installation](user_guide/installation.md) - Setup instructions
- [User Guide](user_guide/README.md) - Usage and configuration
- [CLI Reference](user_guide/cli.md) - Command documentation
- [Tutorials](user_guide/tutorials/README.md) - Step-by-step guides

## Developer Docs

- [Contributing](developer/contributing.md) - Development workflow
- [Architecture](developer/architecture/README.md) - System design
- [API Reference](api/README.md) - Integration guide
 - [Testing](testing/coverage_report.md) - Test coverage and strategy

## Operations

- [Deployment](operations/deployment.md) - Production setup
- [Monitoring](operations/monitoring.md) - Performance tracking
- [Troubleshooting](troubleshooting/search_issues.md) - Common issues
- [Performance Tuning](admin/performance_tuning.md) - Optimization

## Features

- [Content Storage](developer/architecture/README.md) - SHA-256 deduplication
- [Search](user_guide/search_guide.md) - Full-text and semantic
- [MCP Server](user_guide/mcp.md) - AI agent integration
- [REST API](api/README.md) - HTTP interface

## Plugin System (C‑ABI)

YAMS supports optional plugins discovered and managed by the daemon. Plugins use a stable C‑ABI (`include/yams/plugins/abi.h`) and are loaded only from trusted directories.

- Trust file: `~/.config/yams/plugins_trust.txt` (one path per line; default deny until trusted)
- Discovery order:
  - `YAMS_PLUGIN_DIR` (exclusive if set)
  - `$HOME/.local/lib/yams/plugins`
  - `/usr/local/lib/yams/plugins`, `/usr/lib/yams/plugins`
  - `${CMAKE_INSTALL_PREFIX}/lib/yams/plugins` (if installed)
- Disable plugin subsystem: run daemon with `--no-plugins`.

CLI quickstart:

```
# Scan default paths (no load)
yams plugin scan

# Trust a directory, then load the ONNX plugin by path
yams plugin trust add /usr/local/lib/yams/plugins
yams plugin load /usr/local/lib/yams/plugins/libyams_onnx_plugin.so
```

ONNX model provider (host‑backed): when built and trusted, the ONNX plugin advertises `model_provider_v1` and is preferred by the daemon; otherwise it falls back to legacy registry or mock/null providers.

## Build Options

| Option | Default | Description |
|--------|---------|-------------|
| `YAMS_USE_CONAN` | OFF | Use Conan package manager |
| `YAMS_BUILD_CLI` | ON | CLI with optional TUI browser |
| `YAMS_BUILD_MCP_SERVER` | ON | MCP server |
| `YAMS_BUILD_TESTS` | OFF | Unit and integration tests |
| `YAMS_BUILD_BENCHMARKS` | OFF | Performance benchmarks |
| `YAMS_ENABLE_PDF` | ON | PDF text extraction support (may download PDFium via FetchContent) |
| `YAMS_ENABLE_TUI` | ON | Enables the FTXUI-based TUI browser (pass `-Denable-tui=false` to skip) |
| `YAMS_ENABLE_ONNX` | ON | Enables ONNX Runtime features (pulls onnxruntime; may pull Boost transitively) |
| `CMAKE_BUILD_TYPE` | Release | Debug/Release/RelWithDebInfo |

## Resources

- [SourceHut](https://sr.ht/~trvon/yams/) - Primary repo
- [GitHub (mirror)](https://github.com/trvon/yams)
- [Releases](https://github.com/trvon/yams/releases) - Downloads
- [Issues](https://github.com/trvon/yams/issues) - Bug reports
- [Discussions](https://github.com/trvon/yams/discussions) - Community

## Ecosystem

- [Plugins & Projects](ecosystem/README.md) - Community and maintained plugins, projects using YAMS