Skip to content

Commit d07877c

Browse files
committed
use sh in all
1 parent a3a1ea4 commit d07877c

File tree

53 files changed

+177
-177
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+177
-177
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ If you're new to CocoIndex, we recommend checking out
116116

117117
1. Install CocoIndex Python library
118118

119-
```bash
119+
```sh
120120
pip install -U cocoindex
121121
```
122122

dev/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Automatically generates CLI documentation from the CocoIndex Click commands.
1010

1111
**Usage:**
1212

13-
```bash
13+
```sh
1414
python dev/generate_cli_docs.py
1515
```
1616

docs/docs/ai/llm.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ cocoindex.functions.EmbedText(
122122

123123
* [Download](https://ollama.com/download) and install Ollama.
124124
* Pull your favorite LLM models by the `ollama pull` command, e.g.
125-
```bash
125+
```sh
126126
ollama pull llama3.2
127127
```
128128
You can find the [list of models](https://ollama.com/library) supported by Ollama.
@@ -146,7 +146,7 @@ cocoindex.LlmSpec(
146146

147147
For text embedding with Ollama, you'll need to pull an embedding model first:
148148

149-
```bash
149+
```sh
150150
ollama pull nomic-embed-text
151151
```
152152

@@ -330,7 +330,7 @@ To use the LiteLLM API, you need to set the environment variable `LITELLM_API_KE
330330

331331
#### 1. Install LiteLLM Proxy
332332

333-
```bash
333+
```sh
334334
pip install 'litellm[proxy]'
335335
```
336336

@@ -367,7 +367,7 @@ You need to set the environment variable `GROQ_API_KEY` to your Groq API key.
367367

368368
#### 3. Run LiteLLM Proxy
369369

370-
```bash
370+
```sh
371371
litellm --config config.yml
372372
```
373373

@@ -415,13 +415,13 @@ You can find the full list of models supported by OpenRouter [here](https://open
415415

416416
Install vLLM:
417417

418-
```bash
418+
```sh
419419
pip install vllm
420420
```
421421

422422
Run vLLM Server
423423

424-
```bash
424+
```sh
425425
vllm serve deepseek-ai/deepseek-coder-1.3b-instruct
426426
```
427427

docs/docs/core/cli-commands.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Modes of operation:
1313

1414
**Usage:**
1515

16-
```bash
16+
```sh
1717
cocoindex drop [OPTIONS] [APP_TARGET] [FLOW_NAME]...
1818
```
1919

@@ -45,7 +45,7 @@ flow.
4545

4646
**Usage:**
4747

48-
```bash
48+
```sh
4949
cocoindex evaluate [OPTIONS] APP_FLOW_SPECIFIER
5050
```
5151

@@ -72,7 +72,7 @@ the backend.
7272

7373
**Usage:**
7474

75-
```bash
75+
```sh
7676
cocoindex ls [OPTIONS] [APP_TARGET]
7777
```
7878

@@ -95,7 +95,7 @@ It will allow tools like CocoInsight to access the server.
9595

9696
**Usage:**
9797

98-
```bash
98+
```sh
9999
cocoindex server [OPTIONS] APP_TARGET
100100
```
101101

@@ -128,7 +128,7 @@ storage and target (to export to).
128128

129129
**Usage:**
130130

131-
```bash
131+
```sh
132132
cocoindex setup [OPTIONS] APP_TARGET
133133
```
134134

@@ -160,7 +160,7 @@ flow.
160160

161161
**Usage:**
162162

163-
```bash
163+
```sh
164164
cocoindex show [OPTIONS] APP_FLOW_SPECIFIER
165165
```
166166

@@ -184,7 +184,7 @@ or `module:FlowName`. If `:FlowName` is omitted, updates all flows.
184184

185185
**Usage:**
186186

187-
```bash
187+
```sh
188188
cocoindex update [OPTIONS] APP_FLOW_SPECIFIER
189189
```
190190

docs/docs/examples/examples/00_codebase_index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ The flow is composed of the following steps:
5151
- Install Postgres, follow [installation guide](https://cocoindex.io/docs/getting_started/installation#-install-postgres).
5252
- Install CocoIndex
5353

54-
```bash
54+
```sh
5555
pip install -U cocoindex
5656
```
5757

@@ -206,13 +206,13 @@ if __name__ == "__main__":
206206

207207
- Install dependencies
208208

209-
```bash
209+
```sh
210210
pip install -e .
211211
```
212212

213213
- Setup and update the index
214214

215-
```bash
215+
```sh
216216
cocoindex update main
217217
```
218218

@@ -234,7 +234,7 @@ The returned results - each entry contains score (Cosine Similarity), filename,
234234
To get a better understanding of the indexing flow, you can use CocoInsight to help the development step by step.
235235
To spin up, it is super easy.
236236
237-
```bash
237+
```sh
238238
cocoindex server -ci main
239239
```
240240

docs/docs/examples/examples/01_docs_to_knowledge_graph.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -335,13 +335,13 @@ It creates relationships by:
335335

336336
1. Install the dependencies:
337337

338-
```bash
338+
```sh
339339
pip install -e .
340340
```
341341

342342
2. Run following commands to setup and update the index.
343343

344-
```bash
344+
```sh
345345
cocoindex update main
346346
```
347347

@@ -355,7 +355,7 @@ It creates relationships by:
355355
356356
I used CocoInsight to troubleshoot the index generation and understand the data lineage of the pipeline. It is in free beta now, you can give it a try.
357357
358-
```bash
358+
```sh
359359
cocoindex server -ci main
360360
```
361361

docs/docs/examples/examples/02_academic_papers_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -341,7 +341,7 @@ If you need assist with writing the query, please feel free to reach out to us a
341341

342342
You can walk through the project step by step in [CocoInsight](https://www.youtube.com/watch?v=MMrpUfUcZPk) to see exactly how each field is constructed and what happens behind the scenes.
343343

344-
```bash
344+
```sh
345345
cocoindex server -ci main
346346
```
347347

docs/docs/examples/examples/03_postgres_source.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -182,25 +182,25 @@ For example, the following image shows the lineage of the `embedding` field, you
182182
183183
1. Set up dependencies:
184184
185-
```bash
185+
```sh
186186
pip install -e .
187187
```
188188
189189
2. Create the source table with sample data:
190190
191-
```bash
191+
```sh
192192
psql "postgres://cocoindex:cocoindex@localhost/cocoindex" -f ./prepare_source_data.sql
193193
```
194194
195195
3. Setup tables and update the index:
196196
197-
```bash
197+
```sh
198198
cocoindex update main
199199
```
200200
201201
4. Run CocoInsight:
202202
203-
```bash
203+
```sh
204204
cocoindex server -ci main
205205
```
206206
@@ -210,7 +210,7 @@ For example, the following image shows the lineage of the `embedding` field, you
210210
211211
For continuous updating when the source changes, add `-L`:
212212
213-
```bash
213+
```sh
214214
cocoindex update -L main
215215
```
216216

docs/docs/examples/examples/custom_targets.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ output_html.export(
189189

190190
## Run the example
191191

192-
```bash
192+
```sh
193193
pip install -e .
194194
cocoindex update main
195195
```
@@ -198,7 +198,7 @@ You can add, modify, or remove files in the `data/` directory — CocoIndex will
198198

199199
For **real-time updates**, run in live mode:
200200

201-
```bash
201+
```sh
202202
cocoindex update -L main
203203
```
204204

docs/docs/examples/examples/image_search_clip.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -265,7 +265,7 @@ You can check the frontend code [here](https://github.com/cocoindex-io/cocoindex
265265

266266
## Time to have fun!
267267
- Create a collection in Qdrant
268-
```bash
268+
```sh
269269
curl -X PUT 'http://localhost:6333/collections/image_search' \
270270
-H 'Content-Type: application/json' \
271271
-d '{
@@ -279,18 +279,18 @@ You can check the frontend code [here](https://github.com/cocoindex-io/cocoindex
279279
```
280280

281281
- Setup indexing flow
282-
```bash
282+
```sh
283283
cocoindex setup main
284284
```
285285
It is setup with a live updater, so you can add new files to the folder and it will be indexed within a minute.
286286

287287
- Run backend
288-
```bash
288+
```sh
289289
uvicorn main:app --reload --host 0.0.0.0 --port 8000
290290
```
291291

292292
- Run frontend
293-
```bash
293+
```sh
294294
cd frontend
295295
npm install
296296
npm run dev

0 commit comments

Comments
 (0)