| .. | ||
| admin | ||
| adrs | ||
| api | ||
| architecture | ||
| assets | ||
| benchmarks | ||
| changelogs | ||
| ci | ||
| design | ||
| developer | ||
| ecosystem | ||
| external | ||
| hosting | ||
| local-ci | ||
| prompts | ||
| rfcs | ||
| services | ||
| spec | ||
| testing | ||
| user_guide | ||
| BUILD.md | ||
| index.md | ||
| PLUGINS.md | ||
| PROMPT-eng.md | ||
| PROMPT.md | ||
| README.md | ||
| release-policy.md | ||
| roadmap.md | ||
| thanks.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.