# 命令行工具
{props.name || 'Module Federation'} 提供了轻量的命令行工具:{(props.cmdTools || ['@module-federation/enhanced', '@module-federation/modern-js-v3']).map((cmdTool,index,arr)=>(<><code>{cmdTool}</code>{index+1===arr.length ? '':' 和 '}</>))} 。
## 查看所有命令
{/* rspress flattenMdxContent issue */}
{props.show || React.createElement(ViewAllCmdsMdx)}
## 公共选项
{props.name || 'Module Federation'} CLI 提供了一些公共选项,可以用于所有命令:
| 选项 | 描述 |
| ----------------------- | -------------------------------------------------------------------------------------------------------------- |
| `-c, --config <config>` | 指定配置文件路径,可以为相对路径或绝对路径,默认值为 {props.configName ? props.configName : 'module-federation.config.ts'} |
| `-m, --mode <mode>` | 指定运行环境,可以选择 "dev" 或 "prod" ,默认值为 "dev" ,设置后会按照值自动往 `process.env.NODE_ENV` 环境变量注入 "development" 或 "production" |
| `-h, --help` | 显示命令帮助 |
## {props.cmd || 'mf'} dts
{props.cmd || 'mf'}
dts
命令用于拉取或生成 TypeScript 类型声明文件。
{props.commandInfo || <CommandInfo />}
:::info 注意
{props.cmd || 'mf'}
dts
命令会自动根据 {props.configName || 'module-federation.config.ts'}
中的配置生成或拉取类型声明文件。 这意味着你必须提供一个有效的配置文件,否则命令将无法正常运行。
如果你是只使用了 runtime API,那么你需要创建一份临时的 {props.configName || 'module-federation.config.ts'}
文件,配置 [dts.consumeTypes.remoteTypeUrls](/zh/configure/dts.md#remotetypeurls)
,然后运行 {props.cmd || 'mf'}
dts
命令。
:::