Skip to content

Commit 593b025

Browse files
committed
docs: update README.md with prerelease flag
1 parent 3b0a7f8 commit 593b025

1 file changed

Lines changed: 19 additions & 10 deletions

File tree

README.md

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,14 @@ An MCP (Model Context Protocol) server for indexing and querying codebases using
1010
- **Flexible Embeddings**: Local SentenceTransformers (default) or 100+ cloud providers via [LiteLLM](https://docs.litellm.ai/docs/embedding/supported_embedding)
1111
- **SQLite Storage**: Portable, no external database required
1212

13+
## Prerequisites
14+
15+
Install [`uv`](https://docs.astral.sh/uv/getting-started/installation/) (which provides `uvx`):
16+
17+
```bash
18+
curl -LsSf https://astral.sh/uv/install.sh | sh
19+
```
20+
1321
## Usage with Claude Code
1422

1523
No installation needed — `uvx` runs it directly.
@@ -19,7 +27,8 @@ No installation needed — `uvx` runs it directly.
1927
Uses a local SentenceTransformers model (`sentence-transformers/all-MiniLM-L6-v2`). No API key required:
2028

2129
```bash
22-
claude mcp add cocoindex-code -- uvx cocoindex-code@latest
30+
claude mcp add cocoindex-code \
31+
-- uvx --prerelease=explicit --with "cocoindex>=1.0.0a13" cocoindex-code@latest
2332
```
2433

2534
### With a Cloud or Custom Embedding Model
@@ -32,7 +41,7 @@ Set `COCOINDEX_CODE_EMBEDDING_MODEL` to any [LiteLLM-supported model](https://do
3241
```bash
3342
claude mcp add cocoindex-code \
3443
-e COCOINDEX_CODE_EMBEDDING_MODEL=ollama/nomic-embed-text \
35-
-- uvx cocoindex-code@latest
44+
-- uvx --prerelease=explicit --with "cocoindex>=1.0.0a13" cocoindex-code@latest
3645
```
3746

3847
Set `OLLAMA_API_BASE` if your Ollama server is not at `http://localhost:11434`.
@@ -46,7 +55,7 @@ Set `OLLAMA_API_BASE` if your Ollama server is not at `http://localhost:11434`.
4655
claude mcp add cocoindex-code \
4756
-e COCOINDEX_CODE_EMBEDDING_MODEL=text-embedding-3-small \
4857
-e OPENAI_API_KEY=your-api-key \
49-
-- uvx cocoindex-code@latest
58+
-- uvx --prerelease=explicit --with "cocoindex>=1.0.0a13" cocoindex-code@latest
5059
```
5160

5261
</details>
@@ -60,7 +69,7 @@ claude mcp add cocoindex-code \
6069
-e AZURE_API_KEY=your-api-key \
6170
-e AZURE_API_BASE=https://your-resource.openai.azure.com \
6271
-e AZURE_API_VERSION=2024-06-01 \
63-
-- uvx cocoindex-code@latest
72+
-- uvx --prerelease=explicit --with "cocoindex>=1.0.0a13" cocoindex-code@latest
6473
```
6574

6675
</details>
@@ -72,7 +81,7 @@ claude mcp add cocoindex-code \
7281
claude mcp add cocoindex-code \
7382
-e COCOINDEX_CODE_EMBEDDING_MODEL=gemini/text-embedding-004 \
7483
-e GEMINI_API_KEY=your-api-key \
75-
-- uvx cocoindex-code@latest
84+
-- uvx --prerelease=explicit --with "cocoindex>=1.0.0a13" cocoindex-code@latest
7685
```
7786

7887
</details>
@@ -84,7 +93,7 @@ claude mcp add cocoindex-code \
8493
claude mcp add cocoindex-code \
8594
-e COCOINDEX_CODE_EMBEDDING_MODEL=mistral/mistral-embed \
8695
-e MISTRAL_API_KEY=your-api-key \
87-
-- uvx cocoindex-code@latest
96+
-- uvx --prerelease=explicit --with "cocoindex>=1.0.0a13" cocoindex-code@latest
8897
```
8998

9099
</details>
@@ -96,7 +105,7 @@ claude mcp add cocoindex-code \
96105
claude mcp add cocoindex-code \
97106
-e COCOINDEX_CODE_EMBEDDING_MODEL=voyage/voyage-code-3 \
98107
-e VOYAGE_API_KEY=your-api-key \
99-
-- uvx cocoindex-code@latest
108+
-- uvx --prerelease=explicit --with "cocoindex>=1.0.0a13" cocoindex-code@latest
100109
```
101110

102111
</details>
@@ -108,7 +117,7 @@ claude mcp add cocoindex-code \
108117
claude mcp add cocoindex-code \
109118
-e COCOINDEX_CODE_EMBEDDING_MODEL=cohere/embed-english-v3.0 \
110119
-e COHERE_API_KEY=your-api-key \
111-
-- uvx cocoindex-code@latest
120+
-- uvx --prerelease=explicit --with "cocoindex>=1.0.0a13" cocoindex-code@latest
112121
```
113122

114123
</details>
@@ -122,7 +131,7 @@ claude mcp add cocoindex-code \
122131
-e AWS_ACCESS_KEY_ID=your-access-key \
123132
-e AWS_SECRET_ACCESS_KEY=your-secret-key \
124133
-e AWS_REGION_NAME=us-east-1 \
125-
-- uvx cocoindex-code@latest
134+
-- uvx --prerelease=explicit --with "cocoindex>=1.0.0a13" cocoindex-code@latest
126135
```
127136

128137
</details>
@@ -134,7 +143,7 @@ claude mcp add cocoindex-code \
134143
claude mcp add cocoindex-code \
135144
-e COCOINDEX_CODE_EMBEDDING_MODEL=nebius/BAAI/bge-en-icl \
136145
-e NEBIUS_API_KEY=your-api-key \
137-
-- uvx cocoindex-code@latest
146+
-- uvx --prerelease=explicit --with "cocoindex>=1.0.0a13" cocoindex-code@latest
138147
```
139148

140149
</details>

0 commit comments

Comments
 (0)