trevon/yams
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 2
yams/docs
History
Exact
trvon 2946b231dd
 fix: license header file updates, mcp improvements, windows build fixes
2026-01-30 17:23:33 -05:00
..
admin stabilizations. removing http as I am not using it. Focusing on streamlining build and system 2025-11-05 10:52:27 -05:00
adrs Improve daemon shutdown reliability and timeout handling 2026-01-29 11:55:07 -05:00
api completing test migration, mcp tool consolidation, prompt updates 2025-12-22 14:18:31 -05:00
architecture stabilizations. removing http as I am not using it. Focusing on streamlining build and system 2025-11-05 10:52:27 -05:00
assets v0.5.5 2025-08-24 17:15:29 -04:00
benchmarks bug fixes for daemon, ui fixes for grep and search 2026-01-25 22:52:25 -05:00
changelogs fixing homebrew formula logic in ci 2025-12-21 17:06:00 -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 build fixes and benchmark improvements 2026-01-17 16:29:28 -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 stabilizations. removing http as I am not using it. Focusing on streamlining build and system 2025-11-05 10:52:27 -05:00
local-ci v0.7.0-prerelease 2025-09-20 22:55:34 -04:00
plans Improve daemon shutdown reliability and timeout handling 2026-01-29 11:55:07 -05:00
prompts fix: license header file updates, mcp improvements, windows build fixes 2026-01-30 17:23:33 -05:00
research Improve daemon shutdown reliability and timeout handling 2026-01-29 11:55:07 -05:00
rfcs Improve daemon shutdown reliability and timeout handling 2026-01-29 11:55:07 -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 test improvements, bug fix for tuning clamps 2026-01-25 19:08:21 -05:00
spec stabilizations. removing http as I am not using it. Focusing on streamlining build and system 2025-11-05 10:52:27 -05:00
testing improvements for daemon lifecycle, tree repair, and mcp regression 2025-11-26 14:22:35 -05:00
user_guide docs and cli improvements 2026-01-22 03:11:57 +00:00
BUILD.md improvements for daemon lifecycle, tree repair, and mcp regression 2025-11-26 14:22:35 -05:00
index.md improvements for daemon lifecycle, tree repair, and mcp regression 2025-11-26 14:22:35 -05:00
PLUGINS.md improvements for v0.7.10 2025-12-11 22:07:22 -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 improvements for daemon lifecycle, tree repair, and mcp regression 2025-11-26 14:22:35 -05:00
release-policy.md v0.6.12 experiemental 2025-09-11 11:28:42 -04:00
roadmap.md improvements for daemon service management 2025-12-02 12:03:40 -05:00
thanks.md stabilizations. removing http as I am not using it. Focusing on streamlining build and system 2025-11-05 10:52:27 -05:00

README.md

YAMS Documentation

Content-addressed storage with deduplication and semantic search.

Quick Links

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: ~/.config/yams/plugins_trust.txt

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.

Links