ErisPulse-HelpModule
ErisPulse 帮助命令模块,提供自动化的命令帮助系统,支持查看所有可用命令及其用法说明
2.7.0+ 用户推荐使用 ErisPulse-HelpNext(Takumi 图片渲染 / 昼夜主题 / 完整 i18n)。 本模块(HelpModule)继续保留,优先保持向后兼容性,适合无法使用 Takumi 图片渲染或停留在旧版本的环境。
功能特性
提供 Event 子模块中 command 模块中统一的命令帮助功能
- 自动收集并显示所有已注册的命令
- 支持通过序号查看特定命令的详细帮助信息
- 支持命令分组显示
- 可配置是否显示隐藏命令
- 支持命令别名显示
- 会话感知(ErisPulse 2.8.0+):被作用域禁用的模块,其命令不在当前会话的帮助中列出;旧版框架自动回退为全量列表,行为不变
使用方法
基本命令
/help # 显示所有可用命令的列表
/help <序号> # 显示指定序号命令的详细帮助信息
命令别名
/h # 等同于 /help
/帮助 # 等同于 /help
配置选项
模块支持以下配置选项,可以在 config.toml 中进行自定义:
[HelpModule]
show_hidden_commands = false # 是否显示隐藏命令
group_commands = true # 是否按组显示命令
配置说明
show_hidden_commands: 设置为true时,帮助命令会显示被标记为隐藏的命令group_commands: 设置为false时,不按组显示命令,所有命令将在同一列表中显示
依赖
- ErisPulse SDK 2.2.0+
升级到 Next
如果你在使用 ErisPulse 2.7.0+ 且需要图片化帮助(Apple 风格卡片、昼夜主题、多语言),请安装 HelpNext:
epsdk install HelpNext
epsdk uninstall HelpModule
注意:HelpModule 与 HelpNext 都注册
/help命令,请只启用其中一个。
Metadata
Release files for ErisPulse-HelpModule 2.1.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| erispulse_helpmodule-2.1.3.tar.gz | 8.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| erispulse_helpmodule-2.1.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 18.0 kB
Release files / erispulse_helpmodule-2.1.3.tar.gz
| Download URL | erispulse_helpmodule-2.1.3.tar.gz |
|---|---|
| Size | 8.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ec2a4654673bb21d7b9c0a94be03c1374702c64ba2e7781bf8b3c9162d921147
|
|
BLAKE2b-256 checksum How to use checksums |
e94bb12960d8881032b8f258252a7eb71ccf59c0316bd32c482f1b602b69330e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 10, 2026.
Transparency logRelease files / erispulse_helpmodule-2.1.3-py3-none-any.whl
| Download URL | erispulse_helpmodule-2.1.3-py3-none-any.whl |
|---|---|
| Size | 9.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
97fab22e53c44be6869f64dc6ac3bc46e971ce78d1c8e8231ba4d3a635a46933
|
|
BLAKE2b-256 checksum How to use checksums |
58abf49770d8a1c341b90437b9b697701162d27645d1946678c89eb88939bc44
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 10, 2026.
Transparency log