Skip to content

Commit 75a41f7

Browse files
authored
Reformat common CLI option docs as a table (#3513)
Reformat common CLI option docs as a table to make them consistent with auto-generated documentation. Fixes #3512
1 parent afc7082 commit 75a41f7

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

docs/reference/cli.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,21 @@ This page documents all the available commands, related options, and environment
99

1010
### Common Options
1111

12-
To manage indexes, splits and sources, you might need to specify the connection to a Quickwit node. The following options are supported:
12+
To manage indexes, splits and sources on a remote cluster you might need to specify the connection to a Quickwit node. The following options are supported:
1313

14-
`--endpoint` The url of a Quickwit node. Defaults to `http://127.0.0.1:7280`
15-
`--timeout` The command timeout. The default timeout is command specific:
14+
| Option | Description | Default |
15+
|---------------------|-----------------------------|------------------------:|
16+
| `--endpoint` | The url of a Quickwit node. | `http://127.0.0.1:7280` |
17+
| `--timeout` | Command timeout. | *See below* |
18+
| `--connect-timeout` | Connect timeout. | `5s` |
19+
20+
The default timeouts are command specific:
1621
- **search** - 1 minute
1722
- **ingest** (without force or wait) - 1 minute
1823
- **ingest** (with force or wait) - 30 minute
1924
- all other operations - 10 seconds
2025

21-
`--connect-timeout` The connect timeout. Default is 5 seconds.
22-
23-
The timeout can be expressed as in seconds, minutes, hours or days. For examples:
26+
The timeout can be expressed as in seconds, minutes, hours or days. For example:
2427

2528
- `10s` - 10 seconds timeout
2629
- `1m` - 1 minute timeout

0 commit comments

Comments
 (0)