diff --git a/web/content/docs/6-memory.md b/web/content/docs/6-memory.md index d198d6b17..79a24e66c 100644 --- a/web/content/docs/6-memory.md +++ b/web/content/docs/6-memory.md @@ -117,10 +117,11 @@ ai-devkit memory search --query "docker m1" Useful options: -- `--limit ` to control how many results are returned +- `--limit ` to control how many results are returned (1–20, default 5) - `--scope ` to filter results to one scope - `--tags ` to boost matches using context tags - `--table` to print a compact table with `id`, `title`, and `scope` +- `--explain` to include the lexical and semantic rank details behind each result > **Note:** If no results are found, the `results` array is empty. @@ -144,6 +145,17 @@ ai-devkit memory update \ --scope "global" ``` +### Semantic Search + +Memory search is hybrid: lexical matching plus local semantic embeddings, so related entries surface even when the wording differs. The first semantic search (or `semantic download`) fetches a small embedding model that runs entirely on your machine. Manage the model and index with: + +```bash +ai-devkit memory semantic status # model and embedding index state +ai-devkit memory semantic download # download the embedding model (also for offline use) +ai-devkit memory reembed # recompute stale embeddings +ai-devkit memory reembed --force # recompute all embeddings +``` + ## Using the Memory Skill If MCP is not available in your environment, you can install the **memory skill** to teach your AI agent how to use memory via CLI commands.