Skip to content

Commit 081ac45

Browse files
chore: CONFIG HELP doc added (#438)
* chore: CONFIG HELP doc added * chore: CONFIG HELP doc added - minor styling --------- Co-authored-by: Joe Zhou <[email protected]>
1 parent 77f979c commit 081ac45

File tree

2 files changed

+43
-0
lines changed

2 files changed

+43
-0
lines changed
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
description: Learn how to use Redis CONFIG HELP command to list all CONFIG subcommands and their descriptions.
3+
---
4+
5+
import PageTitle from '@site/src/components/PageTitle';
6+
7+
# CONFIG HELP
8+
9+
<PageTitle title="Redis CONFIG HELP Command (Documentation) | Dragonfly" />
10+
11+
## Syntax
12+
13+
CONFIG HELP
14+
15+
**Time complexity:** O(1)
16+
17+
**ACL categories:** @slow
18+
19+
The `CONFIG HELP` command returns a helpful text describing the different `CONFIG` subcommands supported by Dragonfly.
20+
21+
## Return
22+
23+
[Array reply](https://redis.io/docs/latest/develop/reference/protocol-spec/#arrays): a list of subcommands and their descriptions.
24+
25+
## Example
26+
27+
The output of the `CONFIG HELP` command includes the following entries as implemented in Dragonfly:
28+
29+
```shell
30+
dragonfly> CONFIG HELP
31+
1) CONFIG <subcommand> [<arg> [value] [opt] ...]. Subcommands are:
32+
2) GET <pattern>
33+
3) Return parameters matching the glob-like <pattern> and their values.
34+
4) SET <directive> <value>
35+
5) Set the configuration <directive> to <value>.
36+
6) RESETSTAT
37+
7) Reset statistics reported by the INFO command.
38+
8) REWRITE
39+
9) Rewrite the configuration file with the current configuration.
40+
10) HELP
41+
11) Prints this help.
42+
```

docs/command-reference/server-management/config.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,5 +22,6 @@ Currently, the following subcommands are supported:
2222
- [`CONFIG GET`](./config-get.md)
2323
- [`CONFIG RESETSTAT`](./config-resetstat.md)
2424
- [`CONFIG SET`](./config-set.md)
25+
- [`CONFIG HELP`](./config-help.md)
2526

2627
<!-- To see the list of available commands you can call `CONFIG HELP`. -->

0 commit comments

Comments
 (0)