nuxi module
Search and add modules to your Nuxt application with the command line.
Nuxi provides a few utilities to work with Nuxt modules seamlessly.
nuxi module add
Terminal
npx nuxi module add <MODULENAME> [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--skipInstall] [--skipConfig]
| Argument | Description |
|---|---|
MODULENAME | Module name |
| 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 |
The command lets you install Nuxt 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 file
- update your
nuxt.configfile
Example:
Installing the Pinia module
Terminal
npx nuxi module add pinia
nuxi module search
Terminal
npx nuxi module search <QUERY> [--cwd=<directory>] [--nuxtVersion=<2|3>]
Arguments
| Argument | Description |
|---|---|
QUERY | keywords to search for |
Options
| 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) |
The command searches for Nuxt modules matching your query that are compatible with your Nuxt version.
Example:
Terminal
npx nuxi module search pinia