Skip to content

Commit d990b84

Browse files
committed
docs(cli): mention methods to update embeddings.
1 parent 810ad41 commit d990b84

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

docs/cli.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
* [For Windows Users](#for-windows-users)
1010
* [Legacy Environments](#legacy-environments)
1111
* [Getting Started](#getting-started)
12+
* [Refreshing Embeddings](#refreshing-embeddings)
1213
* [If Anything Goes Wrong...](#if-anything-goes-wrong)
1314
* [Advanced Usage](#advanced-usage)
1415
* [Initialising a Project](#initialising-a-project)
@@ -141,6 +142,19 @@ vectorcode drop
141142
To see a full list of CLI options and tricks to optimise the retrieval, keep
142143
reading or use the `--help` flag.
143144

145+
### Refreshing Embeddings
146+
147+
To maintain the accuracy of the vector search, it's important to keep your
148+
embeddings up-to-date. You can simply run the `vectorise` subcommand on a file
149+
to refresh the embedding for a particular file, and the CLI provides a
150+
`vectorcode update` subcommand, which updates the embeddings for all files that
151+
are currently indexed by VectorCode for the current project.
152+
153+
If you want something more automagic, check out
154+
[this secion in the wiki](https://github.com/Davidyz/VectorCode/wiki/Tips-and-Tricks#git-hooks)
155+
about setting up git hooks to trigger automatic embedding updates when you
156+
commit/checkout to a different tag.
157+
144158
### If Anything Goes Wrong...
145159

146160
Please try the following and see if any of these fix your issue:

0 commit comments

Comments
 (0)