*Redis XGROUP HELP 命令

XGROUP HELP 返回 XGROUP 命令各子命令的帮助文本。

---

*语法

XGROUP HELP

---

*参数说明

XGROUP HELP 不需要任何参数。

---

*返回值

• Array：帮助文本数组，每行一条字符串

---

*时间复杂度

O(1)

*

*示例

*查看帮助

> XGROUP HELP
 1) "XGROUP <subcommand> [<arg> [value] [opt] ...]. Subcommands are:"
 2) "CREATE <key> <groupname> <id|$> [option]"
 3) "    Create a new consumer group."
 4) "CREATECONSUMER <key> <groupname> <consumername>"
 5) "    Create a new consumer in a consumer group."
 6) "DELCONSUMER <key> <groupname> <consumername>"
 7) "    Delete a consumer from a consumer group."
 8) "DESTROY <key> <groupname>"
 9) "    Delete a consumer group."
10) "SETID <key> <groupname> <id|$>"
11) "    Set the current group ID and optional entries_read."

---

*常见错误

错误	原因	解决
ERR wrong number of arguments	传入了多余参数	XGROUP HELP 不需要参数

---

*最佳实践

• 在不确定 XGROUP 子命令用法时，使用 XGROUP HELP 快速查看
• 适合 Redis CLI 交互式学习和排查

---

*FAQ

Q1: XGROUP HELP 返回的内容会随版本变化吗？ A: 是的，Redis 版本升级可能会新增子命令，帮助文本会同步更新。

Q2: 可以在脚本中使用 XGROUP HELP 吗？ A: 可以，但通常不需要，建议在交互式 CLI 中使用。

Q3: XGROUP HELP 有对应的 XINFO HELP 吗？ A: 是的，XINFO 也有 HELP 子命令（XINFO HELP），用法相同。