yams/docs
2026-02-27 22:02:35 -05:00
..
admin merge: integrate main into experimental (preserve PBI-081 simplification) 2026-02-19 10:01:01 -05:00
adrs Improve daemon shutdown reliability and timeout handling 2026-01-29 11:55:07 -05:00
api feat: prompt update for code mode mcp 2026-02-20 21:41:54 -05:00
architecture feat: merge and site update 2026-02-14 11:59:36 -05:00
assets v0.5.5 2025-08-24 17:15:29 -04:00
benchmarks feat: fixing bug with multiple processes access gpu, read/write pools now added in metadata repository, and updated plugins for opencode and vscode 2026-02-14 18:16:57 -05:00
changelogs feat: merge and site update 2026-02-14 11:59:36 -05:00
ci v0.6.0 2025-09-03 22:28:13 -04:00
design v0.4.0 staging 2025-08-20 12:17:48 -04:00
developer feat: merge and site update 2026-02-14 11:59:36 -05:00
ecosystem v0.7.5 staging and license updates 2025-10-13 17:07:31 -04:00
external v0.6.35 2025-09-16 18:59:12 -04:00
hosting feat: merge and site update 2026-02-14 11:59:36 -05:00
local-ci v0.7.0-prerelease 2025-09-20 22:55:34 -04:00
prompts Recreate last 7 commits (signed) 2026-02-24 14:32:58 -05:00
research Improve daemon shutdown reliability and timeout handling 2026-01-29 11:55:07 -05:00
rfcs feat: move newsletter to sourcehut 2026-02-14 16:38:23 -05:00
services stabilizations. removing http as I am not using it. Focusing on streamlining build and system 2025-11-05 10:52:27 -05:00
skills/yams feat: large update. Documentation update, config and plugin hardning and improvements related to loading trust. Exposed trust state in the doctor command with hints on improvements. Bug fixes and test improvements to reduce flakiness and TSAN issues 2026-02-26 11:21:29 -05:00
spec feat: large update. Documentation update, config and plugin hardning and improvements related to loading trust. Exposed trust state in the doctor command with hints on improvements. Bug fixes and test improvements to reduce flakiness and TSAN issues 2026-02-26 11:21:29 -05:00
testing improvements for daemon lifecycle, tree repair, and mcp regression 2025-11-26 14:22:35 -05:00
user_guide feat: updating brew install guide 2026-02-27 22:02:35 -05:00
BUILD.md fix: Fixing issues that break windows release build. This should allow new msvc version Working on debug builds. 2026-02-10 15:03:39 -08:00
index.md feat: merge and site update 2026-02-14 11:59:36 -05:00
newsletter.md feat: move newsletter to sourcehut 2026-02-14 16:38:23 -05:00
PLUGINS.md feat: large update. Documentation update, config and plugin hardning and improvements related to loading trust. Exposed trust state in the doctor command with hints on improvements. Bug fixes and test improvements to reduce flakiness and TSAN issues 2026-02-26 11:21:29 -05:00
PROMPT-eng.md fix: license header file updates, mcp improvements, windows build fixes 2026-01-30 17:23:33 -05:00
PROMPT.md improvements for daemon lifecycle, tree repair, and mcp regression 2025-11-26 14:22:35 -05:00
README.md feat: large update. Documentation update, config and plugin hardning and improvements related to loading trust. Exposed trust state in the doctor command with hints on improvements. Bug fixes and test improvements to reduce flakiness and TSAN issues 2026-02-26 11:21:29 -05:00
release-policy.md v0.6.12 experiemental 2025-09-11 11:28:42 -04:00
roadmap.md feat: merge and site update 2026-02-14 11:59:36 -05:00
thanks.md feat: merge and site update 2026-02-14 11:59:36 -05:00

YAMS Documentation Index

Content-addressed storage with deduplication and semantic search.

Documentation Structure

  • Get Started: Installation, CLI, MCP integration
  • User Guides: Tutorials, embeddings, search
  • Admin: Operations, configuration, tuning
  • Developer: Contributing, build system, architecture
  • API: MCP tools, plugin specs
  • Hosting: Managed hosting, self-hosting

Plugin System

YAMS supports C-ABI plugins loaded from trusted directories.

Trust file: <data_dir>/plugins.trust (default: ~/.local/share/yams/plugins.trust)

Discovery paths:

  • YAMS_PLUGIN_DIR (exclusive if set)
  • $HOME/.local/lib/yams/plugins
  • /usr/local/lib/yams/plugins, /usr/lib/yams/plugins

CLI:

yams plugin scan
yams plugin trust add /usr/local/lib/yams/plugins
yams plugin load /path/to/plugin.so

See PLUGINS.md for details.

Build Options (Meson)

Option Default Description
build-cli true Build CLI binary
build-mcp-server true Build MCP server
build-tests false Build test suite
enable-pdf enabled PDF text extraction (qpdf)
enable-onnx enabled ONNX embedding models

See BUILD.md for full build instructions.