Skip to content

Commit 9baca6e

Browse files
authored
Update documentation to use cocoindex update module_name (#1103)
1 parent 171c06e commit 9baca6e

File tree

14 files changed

+25
-25
lines changed

14 files changed

+25
-25
lines changed

docs/docs/core/flow_methods.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ The `cocoindex update` subcommand creates/updates data in the target.
147147
Once it's done, the target data is fresh up to the moment when the command is called.
148148

149149
```sh
150-
cocoindex update main.py
150+
cocoindex update main
151151
```
152152

153153
With a `--setup` option, it will also setup the flow first if needed.
@@ -220,7 +220,7 @@ Change capture mechanisms enable CocoIndex to continuously capture changes from
220220
To perform live update, run the `cocoindex update` subcommand with `-L` option:
221221

222222
```sh
223-
cocoindex update main.py -L
223+
cocoindex update main -L
224224
```
225225

226226
If there's at least one data source with change capture mechanism enabled, it will keep running until aborted (e.g. by `Ctrl-C`).

examples/code_embedding/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,13 +42,13 @@ We will match against user-provided text by a SQL query, reusing the embedding o
4242
- Setup:
4343

4444
```bash
45-
cocoindex setup main.py
45+
cocoindex setup main
4646
```
4747

4848
- Update index:
4949

5050
```bash
51-
cocoindex update main.py
51+
cocoindex update main
5252
```
5353

5454
- Run:

examples/docs_to_knowledge_graph/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,13 +34,13 @@ pip install -e .
3434
Setup:
3535

3636
```bash
37-
cocoindex setup main.py
37+
cocoindex setup main
3838
```
3939

4040
Update index:
4141

4242
```bash
43-
cocoindex update main.py
43+
cocoindex update main
4444
```
4545

4646
### Browse the knowledge graph

examples/fastapi_server_docker/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,13 @@ COCOINDEX_DATABASE_URL=postgres://cocoindex:cocoindex@localhost/cocoindex
2424
- Setup:
2525

2626
```bash
27-
cocoindex setup main.py
27+
cocoindex setup main
2828
```
2929

3030
- Update index:
3131

3232
```bash
33-
cocoindex update main.py
33+
cocoindex update main
3434
```
3535

3636
- Run:

examples/fastapi_server_docker/dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,4 @@ COPY . .
1616

1717
RUN cat .env
1818

19-
CMD ["sh", "-c", "echo yes | cocoindex setup main.py && cocoindex update main.py && python main.py"]
19+
CMD ["sh", "-c", "echo yes | cocoindex setup main && cocoindex update main && python main.py"]

examples/gdrive_text_embedding/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Before running the example, you need to:
5151
- Setup:
5252

5353
```sh
54-
cocoindex setup main.py
54+
cocoindex setup main
5555
```
5656

5757
- Run:

examples/live_updates/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ The script then starts a `FlowLiveUpdater`, which runs in the background and con
4242
This method is useful for managing your indexes from the command line, through CocoIndex [CLI](https://cocoindex.io/docs/core/flow_methods#cli-2).
4343

4444
```bash
45-
cocoindex update main.py -L --setup
45+
cocoindex update main -L --setup
4646
```
4747

4848
4. **Test the live updates:**

examples/manuals_llm_extraction/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,13 @@ pip install -e .
3232
Setup:
3333

3434
```bash
35-
cocoindex setup main.py
35+
cocoindex setup main
3636
```
3737

3838
Update index:
3939

4040
```bash
41-
cocoindex update main.py
41+
cocoindex update main
4242
```
4343

4444
### Query the index

examples/multi_format_indexing/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,13 +42,13 @@ pip install -e .
4242
Setup:
4343

4444
```bash
45-
cocoindex setup main.py
45+
cocoindex setup main
4646
```
4747

4848
Update index:
4949

5050
```bash
51-
cocoindex update main.py
51+
cocoindex update main
5252
```
5353

5454
Run:

examples/patient_intake_extraction/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,13 @@ CocoIndex supports multiple [sources](https://cocoindex.io/docs/ops/sources) and
3232
Setup index:
3333

3434
```bash
35-
cocoindex setup main.py
35+
cocoindex setup main
3636
```
3737

3838
Update index:
3939

4040
```bash
41-
cocoindex update main.py
41+
cocoindex update main
4242
```
4343

4444
Run query:

0 commit comments

Comments
 (0)