trevon/yams
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 2
yams/docs
History
Exact
trvon 58a8cf8efe
 feat: homebrew fixes for nightly formula install
2026-03-24 09:29:16 -04: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: expanding storage system to work with r2 backends via object storage plugin. Updating benchmarks and documentation 2026-03-07 19:43:14 -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 fix: fixing daemon regression for startup logic resulting in ipc eof, expanding release please to update conan file version, expanding benchmark docs 2026-03-07 21:38:35 -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: homebrew fixes for nightly formula install 2026-03-24 09:29:16 -04: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: list and documentation updates 2026-03-06 19:22:40 -05:00
spec feat: adding fuzz test for new download logic, removing r2 endpoint from tests, decoupling embedding / onnxruntime logic for work from previous commit 2026-03-21 18:08:23 -04:00
testing improvements for daemon lifecycle, tree repair, and mcp regression 2025-11-26 14:22:35 -05:00
user_guide refactor(build): centralize dependency discovery and trim Meson duplication 2026-03-23 15:41:13 -04:00
BUILD.md refactor(build): centralize dependency discovery and trim Meson duplication 2026-03-23 15:41:13 -04:00
index.md feat: expanding storage system to work with r2 backends via object storage plugin. Updating benchmarks and documentation 2026-03-07 19:43:14 -05:00
newsletter.md feat: move newsletter to sourcehut 2026-02-14 16:38:23 -05:00
PLUGINS.md feat: expanding storage system to work with r2 backends via object storage plugin. Updating benchmarks and documentation 2026-03-07 19:43:14 -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 refactor(build): centralize dependency discovery and trim Meson duplication 2026-03-23 15:41:13 -04: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

README.md

YAMS Documentation Index

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: <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-onnx enabled ONNX embedding models
plugin-symbols true Tree-sitter symbol extraction

See BUILD.md for full build instructions.

Links