Nuxt/docs/3.api/4.commands/module.md
Michael Brevard 800902df12
docs: add documentation for nuxi module (#24790)
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: Julien Huang <julien.h.dev@gmail.com>
Co-authored-by: Sébastien Chopin <seb@nuxtlabs.com>
Co-authored-by: Damian Głowala <damian.glowala.rebkow@gmail.com>
2023-12-18 13:00:03 +01:00

1.4 KiB

title description links
nuxi module Search and add modules to your Nuxt application with the command line.
label icon to size
Source i-simple-icons-github https://github.com/nuxt/cli/blob/main/src/commands/module/ xs

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

nuxi module add

npx nuxi module add <NAME>
Option Default Description
NAME - The name of the module to install.

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

npx nuxi module add pinia 
npx nuxi module search <QUERY>
Option Default Description
QUERY - The name of the module to search for.

The command searches for Nuxt modules matching your query that are compatible with your Nuxt version.

Example:

npx nuxi module search pinia