1.5 KiB
1.5 KiB
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
| Option | Default | Description |
|---|---|---|
YAMS_BUILD_CLI |
ON | CLI with TUI browser |
YAMS_BUILD_MCP_SERVER |
ON | MCP server |
YAMS_BUILD_TESTS |
OFF | Tests |
YAMS_ENABLE_PDF |
ON | PDF extraction |
YAMS_ENABLE_TUI |
ON | TUI browser |
YAMS_ENABLE_ONNX |
ON | ONNX Runtime |