Skip to content

Commit 6008e61

Browse files
author
Zhe Yu
committed
docs(cli): suggest to pin version to <1.0.0
1 parent 195268d commit 6008e61

1 file changed

Lines changed: 4 additions & 3 deletions

File tree

docs/cli.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,22 +55,23 @@ your system Python or project-local virtual environments.
5555

5656
After installing `uv`, run:
5757
```bash
58-
uv tool install vectorcode
58+
uv tool install "vectorcode<1.0.0"
5959
```
6060
in your shell. To specify a particular version of Python, use the `--python`
6161
flag. For example, `uv tool install vectorcode --python python3.11`. For hardware
6262
accelerated embedding, refer to [the relevant section](#hardware-acceleration).
6363
If you want a CPU-only installation without CUDA dependencies required by
6464
default by PyTorch, run:
6565
```bash
66-
uv tool install vectorcode --index https://download.pytorch.org/whl/cpu --index-strategy unsafe-best-match
66+
uv tool install "vectorcode<1.0.0" --index https://download.pytorch.org/whl/cpu --index-strategy unsafe-best-match
6767
```
6868

6969
If you need to install multiple dependency group (for [LSP](#lsp-mode) or
7070
[MCP](#mcp-server)), you can use the following syntax:
7171
```bash
72-
uv tool install 'vectorcode[lsp,mcp]'
72+
uv tool install "vectorcode[lsp,mcp]<1.0.0"
7373
```
74+
7475
> [!NOTE]
7576
> The command only install VectorCode and `SentenceTransformer`, the default
7677
> embedding engine. If you need to install an extra dependency, you can use

0 commit comments

Comments
 (0)