ContextQMD
Back to Nuxt

nuxt module

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

4.4.42.8 KB
Original Source

Nuxt provides a few utilities to work with Nuxt modules seamlessly.

nuxt module add

<!--module-add-cmd-->
bash
npx nuxt module add <MODULENAME> [--cwd=<directory>] [--logLevel=<silent|info|verbose>] [--skipInstall] [--skipConfig] [--dev]
<!--/module-add-cmd--> <!--module-add-args-->
ArgumentDescription
MODULENAMESpecify one or more modules to install by name, separated by spaces
<!--/module-add-args--> <!--module-add-opts-->
OptionDefaultDescription
--cwd=<directory>.Specify the working directory
--logLevel=<silent|info|verbose>Specify build-time log level
--skipInstallSkip npm install
--skipConfigSkip nuxt.config.ts update
--devInstall modules as dev dependencies
<!--/module-add-opts-->

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.config file

Example:

Installing the Pinia module

bash
npx nuxt module add pinia
<!--module-search-cmd-->
bash
npx nuxt module search <QUERY> [--cwd=<directory>] [--nuxtVersion=<2|3>]
<!--/module-search-cmd-->

Arguments

<!--module-search-args-->
ArgumentDescription
QUERYkeywords to search for
<!--/module-search-args-->

Options

<!--module-search-opts-->
OptionDefaultDescription
--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
npx nuxt module search pinia