1515 * [ Initialising a Project] ( #initialising-a-project )
1616 * [ Configuring VectorCode] ( #configuring-vectorcode )
1717 * [ Vectorising Your Code] ( #vectorising-your-code )
18+ * [ File Specs] ( #file-specs )
1819 * [ Making a Query] ( #making-a-query )
1920 * [ Listing All Collections] ( #listing-all-collections )
2021 * [ Removing a Collection] ( #removing-a-collection )
@@ -151,7 +152,7 @@ to refresh the embedding for a particular file, and the CLI provides a
151152are currently indexed by VectorCode for the current project.
152153
153154If 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+ [ this section in the wiki] ( https://github.com/Davidyz/VectorCode/wiki/Tips-and-Tricks#git-hooks )
155156about setting up git hooks to trigger automatic embedding updates when you
156157commit/checkout to a different tag.
157158
@@ -180,6 +181,13 @@ project-specific settings such as embedding functions and database entry point
180181project-local config file is present, the global configuration file is ignored
181182to avoid confusion.
182183
184+ The same logics apply to [ file specs] ( #file-specs ) , which tells VectorCode what
185+ file it should (or shouldn't) vectorise. If you created a file spec
186+ ` ~/.config/vectorcode/vectorcode.include ` or
187+ ` ~/.config/vectorcode/vectorcode.exclude ` , they will be copied to the
188+ project-local config directory (` project_root/.vectorcode ` ). They also serve as
189+ the fallback value if no project-local specs are present.
190+
183191If you skip ` vectorcode init ` , VectorCode will look for a directory that
184192contains ` .git/ ` subdirectory and use it as the _ project root_ . In this case, the
185193default global configuration will be used. If ` .git/ ` does not exist, VectorCode
@@ -294,6 +302,11 @@ This command also respects `.gitignore`. It by default skips files in
294302` .gitignore ` . To override this, run the ` vectorise ` command with ` -f ` /` --force `
295303flag.
296304
305+ There's also a ` update ` subcommand, which updates the embedding for all the indexed
306+ files and remove the embeddings for files that no longer exist.
307+
308+ #### File Specs
309+
297310As a shorthand, you can create a file at ` project_root/.vectorcode/vectorcode.include ` .
298311This file should follow the same syntax as a
299312[ ` gitignore ` file] ( https://git-scm.com/docs/gitignore ) . Files matched by this
@@ -308,8 +321,10 @@ file to denote any files that you want to exclude. This is useful when you have
308321some files that should be tracked by git, but are not necessary to be indexed by
309322VectorCode.
310323
311- There's also a ` update ` subcommand, which updates the embedding for all the indexed
312- files and remove the embeddings for files that no longer exist.
324+ These specs can be useful if you want to automatically update the embeddings
325+ on certain conditions. See
326+ [ the wiki] ( https://github.com/Davidyz/VectorCode/wiki/Tips-and-Tricks#git-hooks )
327+ for an example to use it with git hooks.
313328
314329### Making a Query
315330
0 commit comments