Skip to content

Commit f1ef341

Browse files
committed
no-mistakes(document): Point README flag notes to the 0.21 upgrade section
1 parent 0621096 commit f1ef341

1 file changed

Lines changed: 5 additions & 14 deletions

File tree

‎README.md‎

Lines changed: 5 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -118,20 +118,11 @@ Pass `--split-identifiers=false` to keep the old behaviour.
118118
| `--graph-only` | off | Skip embedding generation — build the graph and serve structural tools only. No ONNX model load, 10-50× faster indexing. Semantic search and memory tools unavailable. For CI / one-shot graph queries. |
119119
| `--run-tool <name>` | — | One-shot mode: index, run a single tool, print its result, exit. No MCP handshake. Pair with `--tool-args '<json>'`. |
120120

121-
`--split-identifiers` and `--full-body-embedding` both change the text every
122-
symbol is embedded from, and vectors built from different text cannot be ranked
123-
against each other.
124-
A project's stored vectors are therefore stamped with the settings that built
125-
them - `--embedding-model` included, since models differ in dimension - and are
126-
ignored by any process configured differently.
127-
An index written by 0.20.1 or earlier carries no stamp, so it is re-embedded the
128-
first time this version opens it; changing any of the three re-embeds in the
129-
background rather than requiring a manual reindex.
130-
Run `--watch` with the same flags as the sessions that read the project, so both
131-
sides share one set instead of re-embedding over each other.
132-
A daemon left running across an upgrade keeps writing vectors the new build
133-
cannot match, and sessions attached to it serve without semantic search until it
134-
is restarted - so restart `--watch` after upgrading.
121+
`--split-identifiers` and `--full-body-embedding` both change the text every symbol is embedded from, and vectors built from different text cannot be ranked against each other.
122+
A project's stored vectors are therefore stamped with the settings that built them - `--embedding-model` included, since models differ in dimension - and are ignored by any process configured differently.
123+
Changing any of the three re-embeds in the background rather than requiring a manual reindex.
124+
Run `--watch` with the same flags as the sessions that read the project, so both sides share one set instead of re-embedding over each other.
125+
For what this means when upgrading from 0.20.1 or earlier, see [Upgrading to 0.21](#upgrading-to-021).
135126

136127
#### `--embedding-model static` — model2vec fast indexing
137128

0 commit comments

Comments
 (0)