---
title: "nuxt module"
description: "使用命令行在 Nuxt 应用中搜索、添加和移除模块。"
canonical_url: "https://nuxt.zhcndoc.com/docs/4.x/api/commands/module"
---
# nuxt module

> 使用命令行在 Nuxt 应用中搜索、添加和移除模块。

Nuxt 提供了一些实用工具，可无缝处理 [Nuxt modules](https://nuxt.zhcndoc.com/modules)。

## `nuxt module add`

<!--module-add-cmd-->

```bash [Terminal]
npx nuxt module add <MODULENAME...> [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--skipInstall] [--skipConfig] [--dev] [--packageManager=<npm|pnpm|yarn|bun|deno|aube|nub|upm>]
```

<!--/module-add-cmd-->

### 参数

<!--module-add-args-->

| 参数              | 描述                     |
| --------------- | ---------------------- |
| `MODULENAME...` | 指定要按名称安装的一个或多个模块，以空格分隔 |

<!--/module-add-args-->

### 选项

<!--module-add-opts-->

| 选项                                                              | 默认值 | 描述                   |
| --------------------------------------------------------------- | --- | -------------------- |
| `--cwd=<directory>`                                             | `.` | 指定 Nuxt 项目的根目录       |
| `--logLevel=<silent\|info\|verbose>`                            |     | 指定构建时日志级别            |
| `--skipInstall`                                                 |     | 跳过 npm 安装            |
| `--skipConfig`                                                  |     | 跳过 nuxt.config.ts 更新 |
| `--dev`                                                         |     | 将模块作为开发依赖安装          |
| `--packageManager=<npm\|pnpm\|yarn\|bun\|deno\|aube\|nub\|upm>` |     | 用于安装的软件包管理器          |

<!--/module-add-opts-->

该命令可让你无需手动操作即可在应用中安装 [Nuxt modules](https://nuxt.zhcndoc.com/modules)。

运行命令时，它将：

- 使用你的软件包管理器将模块安装为依赖项
- 将其添加到你的 [package.json](https://nuxt.zhcndoc.com/docs/4.x/directory-structure/package) 文件中
- 更新你的 [`nuxt.config`](https://nuxt.zhcndoc.com/docs/4.x/directory-structure/nuxt-config) 文件

**示例：**

安装 [`Pinia`](https://nuxt.zhcndoc.com/modules/pinia) 模块

```bash [Terminal]
npx nuxt module add pinia
```

不指定模块名称运行该命令，即可从与你的 Nuxt 版本兼容的模块中进行选择。

::note
[`nuxt add`](https://nuxt.zhcndoc.com/docs/4.x/api/commands/add) 是相同的命令，同时也接受层。
::

## `nuxt module remove`

<!--module-remove-cmd-->

```bash [Terminal]
npx nuxt module remove [MODULENAME...] [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--skipInstall] [--skipConfig]
```

<!--/module-remove-cmd-->

### 参数

<!--module-remove-args-->

| 参数              | 描述                     |
| --------------- | ---------------------- |
| `MODULENAME...` | 指定要按名称移除的一个或多个模块，以空格分隔 |

<!--/module-remove-args-->

### 选项

<!--module-remove-opts-->

| 选项                                   | 默认值 | 描述                   |
| ------------------------------------ | --- | -------------------- |
| `--cwd=<directory>`                  | `.` | 指定 Nuxt 项目的根目录       |
| `--logLevel=<silent\|info\|verbose>` |     | 指定构建时日志级别            |
| `--skipInstall`                      |     | 跳过依赖卸载               |
| `--skipConfig`                       |     | 跳过 nuxt.config.ts 更新 |

<!--/module-remove-opts-->

该命令会卸载软件包，并将其从你的 [`nuxt.config`](https://nuxt.zhcndoc.com/docs/4.x/directory-structure/nuxt-config) 中的 `modules` 数组移除。

**示例：**

```bash [Terminal]
npx nuxt module remove pinia
```

不指定模块名称运行该命令，即可从项目当前使用的模块中进行选择。

## `nuxt module search`

<!--module-search-cmd-->

```bash [Terminal]
npx nuxt module search <QUERY> [--cwd=<directory>] [--nuxtVersion=<3|4|4.2.0>] [--json]
```

<!--/module-search-cmd-->

![nuxt module search](https://raw.githubusercontent.com/zhcndoc/nuxt-cli/main/capture/output/nuxt-module-search.svg)

### 参数

<!--module-search-args-->

| 参数      | 描述      |
| ------- | ------- |
| `QUERY` | 要搜索的关键词 |

<!--/module-search-args-->

### 选项

<!--module-search-opts-->

| 选项                            | 默认值 | 描述                           |
| ----------------------------- | --- | ---------------------------- |
| `--cwd=<directory>`           | `.` | 指定 Nuxt 项目的根目录               |
| `--nuxtVersion=<3\|4\|4.2.0>` |     | 按 Nuxt 版本筛选，仅列出兼容的模块（默认自动检测） |
| `--json`                      |     | 以 JSON 格式输出结果                |

<!--/module-search-opts-->

该命令会搜索与你的查询匹配且兼容你的 Nuxt 版本的 Nuxt modules，并显示每个模块的描述，同时突出显示匹配的文本。

**示例：**

```bash [Terminal]
npx nuxt module search pinia
```

使用 `--json` 可获取机器可读的 JSON 格式结果。

---

- [来源](https://github.com/nuxt/cli/tree/main/packages/nuxt-cli/src/commands/module)


## Sitemap

See the full [sitemap](https://nuxt.zhcndoc.com/sitemap.md) for all pages.