drupal-module-finder

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Drupal Module Finder

Use the

drupal-module-finder

CLI to find the right Drupal contributed module for a need, learn about it, and get the composer command to install it.

A copy of the command is bundled in this skill directory. Run it as

./drupal-module-finder

from here, or just

drupal-module-finder

if it is on your PATH. All output is raw Markdown. Target a different site with

--host=<url>

(default: http://module-finder.ddev.site).

使用

drupal-module-finder

CLI 查找适合需求的 Drupal 贡献模块、了解模块详情，并获取用于安装模块的 composer 命令。

此 skill 目录中附带了一份该命令的副本。可在此目录中以

./drupal-module-finder

运行；如果 PATH 中已有该命令，也可直接使用

drupal-module-finder

。所有输出均为原始 Markdown。使用

--host=<url>

可指向其他站点（默认值：http://module-finder.ddev.site）。

Always check what is already available first

始终优先检查现有可用项

Before searching for or recommending a new module to download, prefer what the project already has:

Drupal core modules — if core already provides the capability, recommend enabling the core module rather than installing a contributed one.
Already-downloaded modules — modules already present in the codebase (e.g. under
```
web/modules/contrib
```
and
```
web/modules/custom
```
, or listed in the project's
```
composer.json
```
) but not yet enabled. Recommend enabling one of those before adding a new dependency.

Only fall through to the search workflow below when neither Drupal core nor an already-downloaded module covers the need.

在搜索或推荐需要下载的新模块之前，应优先考虑项目已经具备的内容：

Drupal 核心模块 — 如果核心已经提供所需功能，建议启用核心模块，而不是安装贡献模块。
已下载的模块 — 已存在于代码库中但尚未启用的模块（例如位于
```
web/modules/contrib
```
和
```
web/modules/custom
```
下，或列于项目的
```
composer.json
```
中）。建议先启用这些模块，而不是添加新的依赖。

只有在 Drupal 核心和已下载模块都无法满足需求时，才进入下面的搜索流程。

Workflow

工作流程

1. Search by describing the problem

1. 通过描述问题进行搜索

Describe WHAT needs to be solved. Do not put the word "module" in the query — that is implied.

drupal-module-finder semantic-search "send private messages between users"

One focused need per search. Each search must target a single capability — never a whole product or a broad goal. If the user asks for something large like "I want to build Facebook", split it into individual needs and run a separate search for each, one at a time:

drupal-module-finder semantic-search "send private messages between users"
drupal-module-finder semantic-search "poke or react to other people's profiles"
drupal-module-finder semantic-search "news feed of friends' activity"

Run them sequentially (one request at a time) and evaluate each result set on its own. A broad, multi-feature query returns poor matches; a single, specific need returns good ones.

Returns up to 10 candidate modules ranked by semantic relevance.
Each candidate shows: title and data name (in parentheses), a summary, the relevance score, and meta data (data name, project URL, development status, security coverage, stars, project usage, latest release, agentic skills, and Drupal version coverage).
Add
```
--chunk=true
```
to also show the best-matching text excerpt per candidate.
If nothing fits, rephrase the problem and search again.

描述需要解决的具体问题（WHAT）。不要在查询中使用“module”一词，因为该含义已经隐含。

drupal-module-finder semantic-search "send private messages between users"

每次搜索只针对一个明确需求。 每次搜索必须聚焦于单一能力，绝不能针对整个产品或宽泛目标。如果用户提出诸如“我想构建 Facebook”这类大型需求，请将其拆分为多个独立需求，并逐一单独搜索：

drupal-module-finder semantic-search "send private messages between users"
drupal-module-finder semantic-search "poke or react to other people's profiles"
drupal-module-finder semantic-search "news feed of friends' activity"

按顺序运行这些搜索（每次只发出一个请求），并分别评估每组结果。宽泛的多功能查询会返回较差的结果，而单一、具体的需求能够获得更准确的结果。

最多返回 10 个候选模块，并按语义相关性排序。
每个候选项会显示：标题和 data name（括号中的值）、摘要、相关性评分，以及元数据（data name、项目 URL、开发状态、安全覆盖情况、Stars、项目使用量、最新发行版、agentic skills，以及 Drupal 版本覆盖范围）。
添加
```
--chunk=true
```
后，还会为每个候选项显示匹配度最高的文本片段。
如果没有合适的结果，请重新表述问题后再次搜索。

2. Investigate the candidates

2. 调查候选模块

For any promising candidate, use its data name (the value in parentheses, e.g.

Privatemsg (privatemsg)

privatemsg

) to get the full details:

drupal-module-finder module-info privatemsg

Add

--all

for every field, or

--fields=stars,project_usage

to focus on a few.

对于任何有潜力的候选项，使用其 data name（括号中的值，例如

Privatemsg (privatemsg)

privatemsg

）获取完整详情：

drupal-module-finder module-info privatemsg

添加

--all

可查看所有字段，或使用

--fields=stars,project_usage

聚焦于特定字段。

3. Get the install / composer command

3. 获取安装 / composer 命令

Once a module looks right, get its releases and composer commands:

drupal-module-finder release-info privatemsg

Then give the composer command to the user (e.g.

composer require 'drupal/privatemsg:^4.0'

确定合适的模块后，获取其发行版本和 composer 命令：

drupal-module-finder release-info privatemsg

然后向用户提供 composer 命令（例如

composer require 'drupal/privatemsg:^4.0'

）。

All commands

全部命令

Command	What it gives you
`semantic-search "<problem>" [--chunk=true]`	Ranked candidate modules for a described need. Start here. Never cached.
`module-info <data_name> [--all] [--fields=...]`	A module's summary + meta data. `--all` = every field; `--fields=` = only the listed fields (drop the `field_` prefix, e.g. `stars` , `module_categories` ; `title` is allowed).
`release-info <data_name>`	Releases with their composer commands. Use this to install.
`documentation-info <data_name>`	Link to the module's external documentation (or "No documentation found").
`readme <data_name>`	The module's README (or "No readme found").
`file-structure <data_name>`	The module's file/folder structure.

命令	提供的信息
`semantic-search "<problem>" [--chunk=true]`	根据描述的需求返回排序后的候选模块。应从此命令开始。从不缓存。
`module-info <data_name> [--all] [--fields=...]`	模块摘要和元数据。 `--all` 表示所有字段； `--fields=` 表示仅显示指定字段（不要添加 `field_` 前缀，例如 `stars` 、 `module_categories` ；也允许使用 `title` ）。
`release-info <data_name>`	发行版本及其 composer 命令。用于安装。
`documentation-info <data_name>`	模块外部文档的链接（或“No documentation found”）。
`readme <data_name>`	模块的 README（或“No readme found”）。
`file-structure <data_name>`	模块的文件和文件夹结构。

Fields

字段

module-info <data_name> --fields=...

accepts these names (comma-separated, no

field_

prefix). The same names are the labels you will see in the output.

Field	Label	Notes
`title`	Module Name	The node title.
`data_name`	Data Name	Drupal.org machine name (used in every command).
`module_summary`	Module Summary	Short human summary.
`module_description`	Module Description	Longer description.
`module_readme_text`	Module Readme Text	Full README (see also `readme` ).
`documentation`	Documentation	Documentation text.
`external_information`	External Information	External docs link (see also `documentation-info` ).
`link_to_module`	Link to Module	Project URL.
`module_categories`	Module Categories	e.g. Access Control, AI, Automation.
`module_development_status`	Module Development Status	e.g. Actively Maintained, Unsupported.
`development_status`	Development Status	e.g. Under Active Development, Obsolete.
`security_covered`	Security Covered	Covered / Not Covered.
`drupal_version_coverage`	Drupal Version Coverage	e.g. Drupal 10, Drupal 11.
`has_agentic_skills`	Has Agentic Skills	Whether the module ships agentic skills.
`stars`	Stars	Star count.
`project_usage`	Project Usage	Number of sites reporting use.
`latest_release_date`	Latest Release Date	Date of the latest release.
`latest_update`	Latest Update	Last update date.
`latest_module_releases`	Latest Module Releases	Release titles (full detail via `release-info` ).
`module_maintainers`	Module Maintainers	Maintainer names.
`supporting_organizations`	Supporting Organizations	Backing organizations.
`module_affordances`	Module Affordances	What the module lets you do.
`file_structure`	File Structure	File/folder layout (see also `file-structure` ).
`full_vector_search`	Full Vector Search	Aggregated text used for semantic search (large).

Example:

drupal-module-finder module-info privatemsg --fields=stars,project_usage,security_covered,drupal_version_coverage

Use

--all

to dump every field at once (releases expanded).

module-info <data_name> --fields=...

接受以下字段名称（使用逗号分隔，不带

field_

前缀）。这些名称也是输出中显示的标签。

字段	标签	说明
`title`	模块名称	节点标题。
`data_name`	Data Name	Drupal.org 机器名称（用于所有命令）。
`module_summary`	模块摘要	简短的人工摘要。
`module_description`	模块描述	更详细的描述。
`module_readme_text`	模块 README 文本	完整 README（另见 `readme` ）。
`documentation`	文档	文档文本。
`external_information`	外部信息	外部文档链接（另见 `documentation-info` ）。
`link_to_module`	模块链接	项目 URL。
`module_categories`	模块分类	例如 Access Control、AI、Automation。
`module_development_status`	模块开发状态	例如 Actively Maintained、Unsupported。
`development_status`	开发状态	例如 Under Active Development、Obsolete。
`security_covered`	安全覆盖	Covered / Not Covered。
`drupal_version_coverage`	Drupal 版本覆盖范围	例如 Drupal 10、Drupal 11。
`has_agentic_skills`	包含 agentic skills	模块是否附带 agentic skills。
`stars`	Stars 数量	Star 计数。
`project_usage`	项目使用量	报告正在使用该模块的站点数量。
`latest_release_date`	最新发行日期	最新发行版的日期。
`latest_update`	最近更新	最后更新日期。
`latest_module_releases`	最新模块发行版	发行版标题（完整详情请参阅 `release-info` ）。
`module_maintainers`	模块维护者	维护者姓名。
`supporting_organizations`	支持组织	提供支持的组织。
`module_affordances`	模块功能	该模块支持的操作。
`file_structure`	文件结构	文件和文件夹布局（另见 `file-structure` ）。
`full_vector_search`	全量向量搜索	用于语义搜索的聚合文本（内容较大）。

示例：

drupal-module-finder module-info privatemsg --fields=stars,project_usage,security_covered,drupal_version_coverage

使用

--all

可一次输出所有字段，并展开发行版信息。

How they help an evaluation

这些信息如何帮助评估

semantic-search narrows the field fast from a plain-language description.
module-info confirms fit: maintenance and security status, Drupal version coverage, plus usage and stars as trust signals.
release-info gives the exact composer command and version constraints.
readme and documentation-info explain setup and configuration.
file-structure reveals submodules and what ships in the package.

semantic-search 根据自然语言描述快速缩小候选范围。
module-info 确认适配性，包括维护和安全状态、Drupal 版本覆盖范围，以及作为可信度信号的使用量和 Stars。
release-info 提供准确的 composer 命令和版本约束。
readme 和 documentation-info 解释安装、设置和配置方式。
file-structure 展示子模块以及软件包中包含的内容。

Options

选项

```
--host=<url>
```
— point at a different Module Finder site.
```
--chunk=true
```
— (semantic-search) include the best-matching excerpt.
```
--all
```
,
```
--fields=
```
— (module-info) control which fields are shown.

```
--host=<url>
```
— 指向其他 Module Finder 站点。
```
--chunk=true
```
—（semantic-search）包含匹配度最高的文本片段。
```
--all
```
、
```
--fields=
```
—（module-info）控制显示的字段。

Shell completion (bash)

Shell 补全（bash）

Enable TAB completion for subcommands, options,

--fields=

values,

--agent=

values, and any module data names you have already cached:

source <(drupal-module-finder completion bash)

Add that line to your

~/.bashrc

to make it permanent. Completion is registered for the

drupal-module-finder

name on your PATH; running it as

./drupal-module-finder

will not auto-complete.

为子命令、选项、

--fields=

值、

--agent=

值，以及已经缓存的模块 data name 启用 TAB 补全：

source <(drupal-module-finder completion bash)

将此行添加到

~/.bashrc

中即可永久启用。补全功能会为 PATH 中名为

drupal-module-finder

的命令注册；以

./drupal-module-finder

运行时不会自动补全。

Tips

提示

Always search with a problem description — never a module name, and never the word "module".
Carry the data name from the search results into every follow-up command.
Prefer modules that are actively maintained, security-covered, and cover the user's Drupal version.

始终使用问题描述进行搜索，不要使用模块名称，也不要使用“module”一词。
在所有后续命令中沿用搜索结果中的 data name。
优先选择维护活跃、具备安全覆盖，并且支持用户所用 Drupal 版本的模块。