Skip to content

Commit fe3b41f

Browse files
authored
Update help message / docs for the drop subcommand. (#263)
1 parent 3a99578 commit fe3b41f

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

docs/docs/core/cli.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,11 +61,12 @@ The following subcommands are available:
6161
| Subcommand | Description |
6262
| ---------- | ----------- |
6363
| `ls` | List all flows. |
64-
| `server` | Start a HTTP server providing REST APIs. It will allow tools like CocoInsight to access the server. |
65-
| `setup` | Check and apply setup changes for flows, including the internal and target storage (to export). |
6664
| `show` | Show the spec for a specific flow. |
65+
| `setup` | Check and apply backend setup changes for flows, including the internal and target storage (to export). |
66+
| `drop` | Drop the backend setup for specified flows. |
6767
| `update` | Update the index defined by the flow. |
6868
| `evaluate` | Evaluate the flow and dump flow outputs to files. Instead of updating the index, it dumps what should be indexed to files. Mainly used for evaluation purpose. |
69+
| `server` | Start a HTTP server providing REST APIs. It will allow tools like CocoInsight to access the server. |
6970

7071
Use `--help` to see the full list of subcommands, and `subcommand --help` to see the usage of a specific one.
7172

python/cocoindex/cli.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,10 +77,11 @@ def setup():
7777
@click.argument("flow_name", type=str, nargs=-1)
7878
@click.option(
7979
"-a", "--all", "drop_all", is_flag=True, show_default=True, default=False,
80-
help="Drop all flows with persisted setup, even if not defined in the current process.")
80+
help="Drop the backend setup for all flows with persisted setup, "
81+
"even if not defined in the current process.")
8182
def drop(flow_name: tuple[str, ...], drop_all: bool):
8283
"""
83-
Drop the backend for specified flows.
84+
Drop the backend setup for specified flows.
8485
If no flow is specified, all flows defined in the current process will be dropped.
8586
"""
8687
if drop_all:

0 commit comments

Comments
 (0)