Nuxt/docs/3.api/4.commands/module.md

85 lines
2.2 KiB
Markdown
Raw Normal View History

---
title: "nuxi module"
description: "Search and add modules to your Nuxt application with the command line."
links:
- label: Source
icon: i-simple-icons-github
2025-01-16 23:58:26 +00:00
to: https://github.com/nuxt/cli/blob/main/packages/nuxi/src/commands/module/
size: xs
---
Nuxi provides a few utilities to work with [Nuxt modules](/modules) seamlessly.
## nuxi module add
<!--module-add-cmd-->
```bash [Terminal]
npx nuxi module add <MODULENAME> [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--skipInstall] [--skipConfig] [--dev]
```
<!--/module-add-cmd-->
<!--module-add-args-->
Argument | Description
--- | ---
`MODULENAME` | Module name
<!--/module-add-args-->
<!--module-add-opts-->
Option | Default | Description
--- | --- | ---
`--cwd=<directory>` | `.` | Specify the working directory
`--logLevel=<silent\|info\|verbose>` | | Specify build-time log level
`--skipInstall` | | Skip npm install
`--skipConfig` | | Skip nuxt.config.ts update
`--dev` | | Install module as dev dependency
<!--/module-add-opts-->
The command lets you install [Nuxt modules](/modules) in your application with no manual work.
When running the command, it will:
- install the module as a dependency using your package manager
- add it to your [package.json](/docs/guide/directory-structure/package) file
- update your [`nuxt.config`](/docs/guide/directory-structure/nuxt-config) file
**Example:**
Installing the [`Pinia`](/modules/pinia) module
```bash [Terminal]
npx nuxi module add pinia
```
## nuxi module search
<!--module-search-cmd-->
```bash [Terminal]
npx nuxi module search <QUERY> [--cwd=<directory>] [--nuxtVersion=<2|3>]
```
<!--/module-search-cmd-->
### Arguments
<!--module-search-args-->
Argument | Description
--- | ---
`QUERY` | keywords to search for
<!--/module-search-args-->
### Options
<!--module-search-opts-->
Option | Default | Description
--- | --- | ---
`--cwd=<directory>` | `.` | Specify the working directory
`--nuxtVersion=<2\|3>` | | Filter by Nuxt version and list compatible modules only (auto detected by default)
<!--/module-search-opts-->
The command searches for Nuxt modules matching your query that are compatible with your Nuxt version.
**Example:**
```bash [Terminal]
npx nuxi module search pinia
```