{"id":16804363,"url":"https://github.com/he0119/nonebot-plugin-treehelp","last_synced_at":"2025-03-17T03:31:16.760Z","repository":{"id":41541385,"uuid":"509756103","full_name":"he0119/nonebot-plugin-treehelp","owner":"he0119","description":"NoneBot 树形帮助插件","archived":false,"fork":false,"pushed_at":"2025-01-06T22:43:37.000Z","size":372,"stargazers_count":19,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-16T07:51:08.910Z","etag":null,"topics":["nonebot2","plugin","python"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/he0119.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-07-02T12:57:54.000Z","updated_at":"2025-03-10T04:02:52.000Z","dependencies_parsed_at":"2023-10-03T12:46:14.634Z","dependency_job_id":"12544823-d284-4ba2-a704-4fdbb9a13660","html_url":"https://github.com/he0119/nonebot-plugin-treehelp","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/he0119%2Fnonebot-plugin-treehelp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/he0119%2Fnonebot-plugin-treehelp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/he0119%2Fnonebot-plugin-treehelp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/he0119%2Fnonebot-plugin-treehelp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/he0119","download_url":"https://codeload.github.com/he0119/nonebot-plugin-treehelp/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243968876,"owners_count":20376463,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["nonebot2","plugin","python"],"created_at":"2024-10-13T09:44:53.758Z","updated_at":"2025-03-17T03:31:16.497Z","avatar_url":"https://github.com/he0119.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!-- markdownlint-disable MD033 MD036 MD041 --\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://v2.nonebot.dev/\"\u003e\u003cimg src=\"https://v2.nonebot.dev/logo.png\" width=\"200\" height=\"200\" alt=\"nonebot\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cdiv align=\"center\"\u003e\n\n# NoneBot Plugin TreeHelp\n\n_✨ NoneBot 树形帮助插件 ✨_\n\n\u003c/div\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://raw.githubusercontent.com/he0119/nonebot-plugin-treehelp/main/LICENSE\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/license/he0119/nonebot-plugin-treehelp.svg\" alt=\"license\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://pypi.python.org/pypi/nonebot-plugin-treehelp\"\u003e\n    \u003cimg src=\"https://img.shields.io/pypi/v/nonebot-plugin-treehelp.svg\" alt=\"pypi\"\u003e\n  \u003c/a\u003e\n  \u003cimg src=\"https://img.shields.io/badge/python-3.9+-blue.svg\" alt=\"python\"\u003e\n  \u003ca href=\"https://codecov.io/gh/he0119/nonebot-plugin-treehelp\"\u003e\n    \u003cimg src=\"https://codecov.io/gh/he0119/nonebot-plugin-treehelp/branch/main/graph/badge.svg?token=jd5ufc1alv\" alt=\"codecov\"/\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://jq.qq.com/?_wv=1027\u0026k=7zQUpiGp\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/QQ%E7%BE%A4-730374631-orange?style=flat-square\" alt=\"QQ Chat Group\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n## 简介\n\n使用插件元数据获取插件信息，并通过插件与子插件的组织形式，来区分插件的多种功能。\n\n树形帮助插件，最重要的功能当然是显示插件树！\n\n发送 `/help --tree`，你将获得如下帮助：\n\n```text\n插件：\n帮助 # 获取插件帮助信息\n测试 # 一个测试插件\n├── 复杂功能 # 测试插件复杂子插件\n│   └── 二级功能 # 测试插件二级插件\n└── 简单功能 # 测试插件简单子插件\n```\n\n## 使用方式\n\n加载插件后发送 `/help help` 或 `/help --help` 获取具体用法。\n\n## 插件适配\n\n插件与子插件写法可参考 [示例插件](./tests/plugins/tree/)。\n\n### 声明适配器\n\n通过设置 adapters 属性来指定支持的适配器。如果不设置或留空则默认支持全部适配器。如果插件不支持该适配器，则不会在帮助列表上显示。\n\n```python\n__plugin_meta__ = PluginMetadata(\n    name=\"OneBot\",\n    description=\"测试 OneBot 适配器\",\n    usage=\"/onebot\",\n    type=\"application\",\n    supported_adapters={\"~onebot.v11\", \"~onebot.v12\"},\n)\n```\n\n## 配置项\n\n配置方式：直接在 `NoneBot` 全局配置文件中添加以下配置项即可。\n\n### treehelp_ignored_plugins\n\n- 类型: `list[str]`\n- 默认: `[]`\n- 说明: 需要忽略的插件名称列表\n\n## 计划\n\n- [ ] 支持输出插件版本\n- [x] 支持输出插件树\n- [ ] 支持输出插件内的命令名称\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhe0119%2Fnonebot-plugin-treehelp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhe0119%2Fnonebot-plugin-treehelp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhe0119%2Fnonebot-plugin-treehelp/lists"}