---
title: "Nuxt CLI"
description: "Nuxt CLI 可从命令行运行、构建和检查你的 Nuxt 应用"
canonical_url: "https://nuxt.zhcndoc.com/docs/3.x/api/commands/overview"
---
# Nuxt CLI

> Nuxt CLI 可从命令行运行、构建和检查你的 Nuxt 应用

`@nuxt/cli` 就是 `nuxt` 命令：它运行开发服务器，为生产环境构建你的应用，生成文件，管理模块，并回答有关项目的问题。它是 `nuxt` 的依赖项，因此 Nuxt 项目已经包含它。

```bash [Terminal]
npx nuxt dev
```

该二进制文件安装为 `nuxt`，同时也安装为 `nuxi`、`nuxi-ng` 和 `nuxt-cli`，以兼容较旧的设置。

另外还有两个软件包针对不同情况提供相同的命令。`nuxi` 是一个没有运行时依赖的独立构建版本，用于在项目外运行命令或全局安装。生成新项目使用 [`create-nuxt`](https://nuxt.zhcndoc.com/docs/3.x/api/commands/init)，这是一个独立的软件包，因此可以在没有项目可安装的情况下运行。

## 运行命令

在项目内，你的包管理器会运行项目所依赖的版本：

```bash [Terminal]
pnpm nuxt dev
npm exec nuxt dev
yarn nuxt dev
bun nuxt dev
```

在项目外，`npx nuxi` 会从自身捆绑的副本中运行相同的命令。

## 全局选项

`--cwd` 可以在命令名称之前或之后传递，这在 monorepo 中很有用：

```bash [Terminal]
npx nuxt --cwd apps/web dev
```

接受 `ROOTDIR` 位置参数的命令会将显式的 `--cwd` 视为对它的覆盖。任何命令上的 `--help` 都会打印其参数和选项，`--version` 会打印 CLI 版本。

需要 Node.js 18 或更高版本。较旧的版本仍然可以运行，但会发出不受支持的警告。

## 项目命令

如果 CLI 不提供某个命令，就会在你的项目中查找名为 `nuxt-<command>` 的二进制文件，因此依赖项可以添加自己的命令。 [`nuxt build-module`](https://nuxt.zhcndoc.com/docs/3.x/api/commands/build-module) 就是这样工作的：它运行由 `@nuxt/module-builder` 安装的 `nuxt-build-module` 二进制文件。

## Shell 补全

`nuxt complete <shell>` 会打印补全脚本，该功能由 [`@bomb.sh/tab`](https://github.com/bombshell-dev/tab) 提供支持。它可以补全命令、标志和一些标志值：`nuxt dev` 的端口和主机，`nuxt build --preset` 的 Nitro 预设，`nuxt init --template` 的初始模板，以及日志级别。

::code-group
```bash [zsh]
npx nuxt complete zsh > "${fpath[1]}/_nuxt"
```

```bash [bash]
npx nuxt complete bash > /etc/bash_completion.d/nuxt
```

```bash [fish]
npx nuxt complete fish > ~/.config/fish/completions/nuxt.fish
```
::

同时也支持 `powershell`，并且 `create-nuxt complete <shell>` 有自己的脚本，可以补全初始模板名称。

::note
如果你安装了 [tab 的包管理器补全](https://github.com/bombshell-dev/tab?tab=readme-ov-file#package-manager-completions)，也可以通过包管理器使用补全功能（`pnpm nuxt <Tab>`）。
::

## 调试 CLI

设置 `DEBUG=nuxi`，可以从 CLI 本身获取额外的诊断信息，例如开发服务器启动耗时，以及它在清理过程中移除的路径。

## 预发布版本

每次提交都会发布到 nightly 频道：

```bash [Terminal]
npm install -D @nuxt/cli-nightly
npx @nuxt/cli-nightly dev
```

`create-nuxt-nightly` 会使用它生成项目，而 `npm create nuxt@latest --nightly` 会针对 Nuxt nightly 频道生成项目。

单个拉取请求的构建版本由 [pkg.pr.new](https://pkg.pr.new) 发布，并从拉取请求本身链接出去，这是在修复发布之前检查其是否有效的最快方式。

---

- [来源](https://github.com/nuxt/cli)


## Sitemap

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