*Redis XINFO HELP 命令

XINFO HELP 用于返回 XINFO 子命令的帮助文本，列出所有可用的子命令及其说明。

---

*语法

XINFO HELP

---

*参数说明

参数	类型	必填	说明
无	—	—	无参数

---

*返回值

• Array：子命令列表及其描述文本
• Error：极少出现，通常无错误

---

*时间复杂度

O(1)

*

*示例

*获取帮助信息

> XINFO HELP
 1) "XINFO <subcommand> [<arg> [value] ...]"
 2) "Subcommands are:"
 3) "CONSUMERS <key> <group>"
 4) "    Show consumers of the specified group."
 5) "GROUPS <key>"
 6) "    Show the consumer groups of the specified stream."
 7) "STREAM <key> [FULL [COUNT <count>]]"
 8) "    Show information about the stream."
 9) "HELP"
10) "    Prints this help."

*快速查看支持的子命令

> XINFO HELP
1) "XINFO <subcommand> [<arg> [value] ...]"
...

---

*常见错误

错误	原因	解决
ERR wrong number of arguments	传入了额外参数	XINFO HELP 不需要参数

---

*最佳实践

• 不确定 XINFO 有哪些子命令时，先执行 XINFO HELP
• 在自动化脚本中可用于检测 Redis 版本支持的子命令集合
• 与其他 HELP 命令（如 XGROUP HELP）配合使用，快速掌握 Stream 命令体系

---

*FAQ

Q1: XINFO HELP 返回的内容会随 Redis 版本变化吗？ A: 会。新版本可能增加新子命令（如 IDMP 相关），旧版本可能缺少某些子命令。

Q2: 如何获取更详细的子命令文档？ A: XINFO HELP 只提供简要说明，详细文档请参考各子命令的独立页面（如 XINFO STREAM、XINFO GROUPS）。

Q3: XINFO HELP 和 COMMAND INFO xinfo 有什么区别？ A: XINFO HELP 提供语义级别的子命令说明；COMMAND INFO 提供协议级别的命令元数据（参数数量、标志位等）。