For AI agents: the complete documentation index is available at /en/llms.txt, the full documentation bundle is available at /en/llms-full.txt, and this page is available as Markdown at /en/reference/sdk/contracts/interfaces/ModuleCatalogEntry.md.
  • English
  • Interface: ModuleCatalogEntry

    Defined in: contracts/module.ts:17

    模块目录(catalog)中单条模块元数据。

    Properties

    PropertyTypeDescriptionDefined in
    idstring模块唯一标识符contracts/module.ts:19
    configKeystring对应 configs/ 目录下的配置文件基名contracts/module.ts:21
    namestring模块显示名称。contracts/module.ts:23
    descriptionstring模块功能简要描述。contracts/module.ts:25
    enabledByDefaultboolean安装后是否默认处于启用状态。contracts/module.ts:27
    canDisableboolean是否允许通过 CLI/API 写入禁用状态(下次冷启动生效)。contracts/module.ts:29
    requiresstring[]硬依赖的模块 id 列表。contracts/module.ts:31
    optional?string[]可选依赖的模块 id 列表contracts/module.ts:33
    commands?string[]模块注册的指令名列表contracts/module.ts:35
    entryModuleEntryPathSAPI 入口定义。contracts/module.ts:37
    semantic?Record<string, unknown>v3 semantic 语义块contracts/module.ts:39