Documentation menuCLI
CLI
cosine build and cosine search.
cosine build <docs-dir> [options] Build a search index from Markdown, MDX and HTML files
cosine search <index-dir> <query> Try a query against a built index
cosine build
| Option | Default | |
|---|---|---|
--out <dir> | public/cosine | Output directory |
--base-url <path> | / | URL prefix of the pages |
--model <id> | english | english, multilingual or a Hugging Face model id |
--lexical-only | No embeddings, keyword search only (no model download) | |
--exclude <path> | Skip files whose path starts with this (repeatable) | |
--max-chars <n> | 1200 | Soft maximum chunk length |
--query-prefix <s> | Prefix for queries (custom E5/BGE models) | |
--passage-prefix <s> | Prefix for passages (custom E5/BGE models) |
Writes cosine-index.json (chunks and settings) and cosine-vectors.bin (int8 vectors) to the output directory.
cosine search
| Option | Default | |
|---|---|---|
--mode <mode> | hybrid | hybrid, lexical or semantic |
--limit <n> | 5 | Number of results |
Exit code 0 on success, 1 on errors.