Skip to content

Commit 1eac6b1

Browse files
authored
Update documentation to use cocoindex update --setup main with modu… (#1093)
Update documentation to use `cocoindex update --setup main` with module name directly - Changed `cocoindex update --setup main.py` to `cocoindex update --setup main` across all examples and documentation - Updated all README.md files in /examples directory - Updated documentation files in /docs directory including quickstart and example guides - Fixes #1089
1 parent 0dc1a48 commit 1eac6b1

File tree

13 files changed

+14
-14
lines changed

13 files changed

+14
-14
lines changed

docs/docs/core/flow_methods.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ cocoindex update main.py
153153
With a `--setup` option, it will also setup the flow first if needed.
154154

155155
```sh
156-
cocoindex update --setup main.py
156+
cocoindex update --setup main
157157
```
158158

159159
With a `--reexport` option, it will reexport the targets even if there's no change.

docs/docs/examples/examples/codebase_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ if __name__ == "__main__":
203203

204204
- Setup and update the index
205205
```sh
206-
cocoindex update --setup main.py
206+
cocoindex update --setup main
207207
```
208208
You'll see the index updates state in the terminal
209209

docs/docs/examples/examples/custom_targets.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,7 @@ output_html.export(
192192

193193
```bash
194194
pip install -e .
195-
cocoindex update --setup main.py
195+
cocoindex update --setup main
196196
```
197197

198198
You can add, modify, or remove files in the `data/` directory — CocoIndex will only reprocess the changed files and update the target accordingly.

docs/docs/examples/examples/docs_to_knowledge_graph.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -334,7 +334,7 @@ It creates relationships by:
334334

335335
2. Run following commands to setup and update the index.
336336
```sh
337-
cocoindex update --setup main.py
337+
cocoindex update --setup main
338338
```
339339

340340
You'll see the index updates state in the terminal. For example,

docs/docs/examples/examples/patient_form_extraction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,7 @@ patients_index.export(
229229

230230
### Setup and update the index
231231
```sh
232-
cocoindex update --setup main.py
232+
cocoindex update --setup main
233233
```
234234
You'll see the index updates state in the terminal
235235

docs/docs/examples/examples/postgres_source.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ For example, the following image shows the lineage of the `embedding` field, you
196196
3. Setup tables and update the index:
197197
198198
```bash
199-
cocoindex update --setup main.py
199+
cocoindex update --setup main
200200
```
201201
202202
4. Run CocoInsight:

docs/docs/examples/examples/product_recommendation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -364,7 +364,7 @@ Note that different relationships may share the same source and target nodes.
364364
365365
2. Run the following command to setup and update the index.
366366
```sh
367-
cocoindex update --setup main.py
367+
cocoindex update --setup main
368368
```
369369
370370
You'll see the index updates state in the terminal. For example, you'll see the following output:

docs/docs/examples/examples/simple_vector_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -204,7 +204,7 @@ There're two CocoIndex-specific logic:
204204
- Run the following command to setup and update the index.
205205

206206
```sh
207-
cocoindex update --setup main.py
207+
cocoindex update --setup main
208208
```
209209

210210
- Start the interactive query in terminal.

docs/docs/getting_started/quickstart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ CocoIndex supports other vector databases as well, with 1-line switch.
152152
- Build the index:
153153

154154
```bash
155-
cocoindex update --setup main.py
155+
cocoindex update --setup main
156156
```
157157

158158
CocoIndex will run for a few seconds and populate the target table with data as declared by the flow. It will output the following statistics:

examples/custom_output_files/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ pip install -e .
2828
Update the target:
2929

3030
```bash
31-
cocoindex update --setup main.py
31+
cocoindex update --setup main
3232
```
3333

3434
You can add new files to the `data/` directory, delete or update existing files.

0 commit comments

Comments
 (0)