Skip to content

Commit d064d99

Browse files
Davidyzgithub-actions[bot]
authored andcommitted
Auto generate docs
1 parent dc44ba9 commit d064d99

File tree

1 file changed

+20
-37
lines changed

1 file changed

+20
-37
lines changed

doc/VectorCode-cli.txt

Lines changed: 20 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@ Table of Contents *VectorCode-cli-table-of-contents*
1616

1717
- |VectorCode-cli-installation|
1818
- |VectorCode-cli-install-from-source|
19-
- |VectorCode-cli-migration-from-`pipx`|
2019
- |VectorCode-cli-chromadb|
2120
- |VectorCode-cli-for-windows-users|
2221
- |VectorCode-cli-legacy-environments|
@@ -66,7 +65,7 @@ virtual environments.
6665
After installing `uv`, run:
6766

6867
>bash
69-
uv tool install "vectorcode<1.0.0"
68+
uv tool install "vectorcode[chroma0]"
7069
<
7170

7271
in your shell. To specify a particular version of Python, use the `--python`
@@ -76,40 +75,25 @@ If you want a CPU-only installation without CUDA dependencies required by
7675
default by PyTorch, run:
7776

7877
>bash
79-
uv tool install "vectorcode<1.0.0" --index https://download.pytorch.org/whl/cpu --index-strategy unsafe-best-match
78+
uv tool install "vectorcode[chroma0]" --index https://download.pytorch.org/whl/cpu --index-strategy unsafe-best-match
8079
<
8180

8281
If you need to install multiple dependency group (for |VectorCode-cli-lsp| or
8382
|VectorCode-cli-mcp|), you can use the following syntax:
8483

8584
>bash
86-
uv tool install "vectorcode[lsp,mcp]<1.0.0"
85+
uv tool install "vectorcode[lsp,mcp,chroma0]"
8786
<
8887

8988

9089
[!NOTE] The command only install VectorCode and `SentenceTransformer`, the
9190
default embedding engine. If you need to install an extra dependency, you can
92-
use `uv tool install vectorcode --with <your_deps_here>`
91+
use `uv tool install vectorcode[chroma0] --with <your_deps_here>`
9392

9493
INSTALL FROM SOURCE ~
9594

96-
To install from source, either `git clone` this repository and run `uv tool
97-
install <path_to_vectorcode_repo>`, or use `pipx`:
98-
99-
>bash
100-
pipx install git+https://github.com/Davidyz/VectorCode
101-
<
102-
103-
104-
MIGRATION FROM PIPX ~
105-
106-
The motivation behind the change from `pipx` to `uv tool` is mainly the
107-
performance. The caching mechanism in uv makes it a lot faster than `pipx` for
108-
a lot of operations. If you installed VectorCode via `pipx`, you can continue
109-
to use `pipx` to manage your VectorCode installation. If you wish to switch to
110-
`uv`, you need to uninstall VectorCode using `pipx` and then use `uv` to
111-
install it as described above. All your VectorCode configurations and database
112-
files will work out of the box on your new install.
95+
To install from source, please `git clone` this repository and run `uv tool
96+
install <path_to_vectorcode_repo>`.
11397

11498

11599
CHROMADB ~
@@ -124,9 +108,6 @@ instructions through docker
124108
significantly reduce the IO overhead and avoid potential race condition.
125109

126110

127-
If you’re setting up a standalone ChromaDB server, I recommend sticking to
128-
v0.6.3, because VectorCode is not ready for the upgrade to ChromaDB 1.0 yet.
129-
130111
FOR WINDOWS USERS ~
131112

132113
Windows support is not officially tested at this moment. This PR
@@ -370,7 +351,7 @@ and values are lists of Python regex patterns
370351
This allows overriding automatic language detection and specifying a treesitter
371352
parser for certain file types for which the language parser cannot be correctly
372353
identified (e.g., `.phtml` files containing both php and html). Example
373-
configuration: `json5 "filetype_map": { "php": ["^phtml$"] }`
354+
configuration: `json5 { "filetype_map": { "php": ["^phtml$"], }, }`
374355

375356
- `chunk_filters`: `dict[str, list[str]]`, a dictionary where the keys are
376357
language name
@@ -381,10 +362,12 @@ configuration: `json5 "filetype_map": { "php": ["^phtml$"] }`
381362
treesitter chunker. By default, no filters will be added. Example
382363
configuration:
383364
>json5
384-
"chunk_filters": {
385-
"python": ["^[^a-zA-Z0-9]+$"], // multiple patterns will be merged (unioned)
386-
// or you can use wildcard to match any languages that has no dedicated filters:
387-
"*": ["^[^a-zA-Z0-9]+$"],
365+
{
366+
"chunk_filters": {
367+
"python": ["^[^a-zA-Z0-9]+$"], // multiple patterns will be merged (unioned)
368+
// or you can use wildcard to match any languages that has no dedicated filters:
369+
"*": ["^[^a-zA-Z0-9]+$"],
370+
},
388371
}
389372
<
390373
- `encoding`: string, alternative encoding used for this project. By default this
@@ -729,13 +712,13 @@ A JSON array of collection information of the following format will be printed:
729712

730713
>json
731714
{
732-
"project_root": str,
733-
"user": str,
734-
"hostname": str,
735-
"collection_name": str,
736-
"size": int,
737-
"num_files": int,
738-
"embedding_function": str
715+
"project_root": "project_root",
716+
"user": "user",
717+
"hostname": "host",
718+
"collection_name": "fuerbvo13571943ofuib",
719+
"size": 10,
720+
"num_files": 100,
721+
"embedding_function": "SomeEmbeddingFunction"
739722
}
740723
<
741724

0 commit comments

Comments
 (0)