---
title: "Nuxt Kit"
description: "@nuxt/kit 为模块作者提供功能。"
canonical_url: "https://nuxt.zhcndoc.com/docs/3.x/guide/going-further/kit"
---
# Nuxt Kit

> @nuxt/kit 为模块作者提供功能。

Nuxt Kit 提供可组合的实用工具，让你可以轻松地使用 [Nuxt Hooks](https://nuxt.zhcndoc.com/docs/3.x/api/advanced/hooks)、[Nuxt Interface](https://nuxt.zhcndoc.com/docs/3.x/guide/going-further/internals#the-nuxt-interface) 并开发 [Nuxt 模块](https://nuxt.zhcndoc.com/docs/3.x/guide/modules)。

::read-more{to="https://nuxt.zhcndoc.com/docs/3.x/api/kit"}
了解所有 Nuxt Kit 实用工具。
::

## 用法

### 安装依赖

你可以通过将其添加到 `package.json` 的 `dependencies` 部分来安装最新的 Nuxt Kit。不过，即使 Nuxt 已经安装了 `@nuxt/kit`，也建议你始终明确安装该包。

::note
`@nuxt/kit` 和 `@nuxt/schema` 是 Nuxt 的关键依赖。如果你单独安装它们，请确保 `@nuxt/kit` 和 `@nuxt/schema` 的版本大于或等于你的 `nuxt` 版本，以避免任何意外行为。
::

```json [package.json]
{
  "dependencies": {
    "@nuxt/kit": "npm:@nuxt/kit-nightly@latest"
  }
}
```

### 导入 Kit 实用工具

```ts [test.mjs]
import { useNuxt } from '@nuxt/kit'
```

::read-more{to="https://nuxt.zhcndoc.com/docs/3.x/api/kit"}
::

::note
Nuxt Kit 实用工具仅可用于模块，并不适合在运行时（组件、Vue 组合函数、页面、插件或服务器路由中）导入。
::

Nuxt Kit 是一个[仅限 ESM 的包](https://nuxt.zhcndoc.com/docs/3.x/guide/concepts/esm)，这意味着你**不能**使用 `require('@nuxt/kit')`。作为一种变通方法，可以在 CommonJS 环境中使用动态导入：

```ts [test.cjs]
// 这样用是不行的！
// const kit = require('@nuxt/kit')
async function main () {
  const kit = await import('@nuxt/kit')
}
main()
```


## Sitemap

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