yams/docs

YAMS Documentation

Content-addressed storage with deduplication and semantic search.

Quick Start

• Installation - Setup YAMS
• CLI Guide - Command reference
• API Docs - Integration reference
• Examples - Usage examples

User Docs

• Installation - Setup instructions
• User Guide - Usage and configuration
• CLI Reference - Command documentation
• Tutorials - Step-by-step guides

Developer Docs

• Contributing - Development workflow
• Architecture - System design
• API Reference - Integration guide
• Testing - Test coverage and strategy

Operations

• Deployment - Production setup
• Monitoring - Performance tracking
• Troubleshooting - Common issues
• Performance Tuning - Optimization

Features

• Content Storage - SHA-256 deduplication
• Search - Full-text and semantic
• MCP Server - AI agent integration
• REST API - HTTP interface

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	OFF	Enables TUI browser (adds ncurses via Conan; ImTUI via FetchContent)
YAMS_ENABLE_ONNX	ON	Enables ONNX Runtime features (pulls onnxruntime; may pull Boost transitively)
CMAKE_BUILD_TYPE	Release	Debug/Release/RelWithDebInfo

Resources

• GitHub - Source code
• Releases - Downloads
• Issues - Bug reports
• Discussions - Community

Academic Work

• Academic Paper - USENIX conference paper development
• Paper PBI - Academic publication project tracking
• Paper Source - LaTeX source and compilation