---
url: /api/reference.md
---

#  WXT

[![npm version](https://img.shields.io/npm/v/wxt?labelColor=black\&color=%234fa048)](https://www.npmjs.com/package/wxt)
[![downloads](https://img.shields.io/npm/dm/wxt?labelColor=black\&color=%234fa048)](https://www.npmjs.com/package/wxt)
[![license | MIT](https://img.shields.io/npm/l/wxt?labelColor=black\&color=%234fa048)](https://github.com/wxt-dev/wxt/blob/main/LICENSE)
[![coverage](https://img.shields.io/codecov/c/github/wxt-dev/wxt?labelColor=black\&color=%234fa048)](https://codecov.io/github/wxt-dev/wxt)

Next-gen framework for developing web extensions.⚡It's like Nuxt, but for Web Extensions

[Get Started](https://wxt.dev/guide/installation.html) •
[Configuration](https://wxt.dev/api/reference/wxt/interfaces/inlineconfig.html) •
[Examples](https://wxt.dev/examples.html) •
[Changelog](https://github.com/wxt-dev/wxt/blob/main/packages/wxt/CHANGELOG.md) •
[Discord](https://discord.gg/ZFsZqGery9)

![Example CLI Output](https://raw.githubusercontent.com/wxt-dev/wxt/HEAD/docs/assets/cli-output.png)

## Contents

* [Demo](#demo)
* [Quick Start](#quick-start)
* [Features](#features)
* [Sponsors](#sponsors)
* [Contributors](#contributors)

## Demo

<https://github.com/wxt-dev/wxt/assets/10101283/4d678939-1bdb-495c-9c36-3aa281d84c94>

## Quick Start

Bootstrap a new project:

```sh
# npm
npx wxt@latest init

# pnpm
pnpm dlx wxt@latest init

# bun
bunx wxt@latest init
```

Or see the [installation guide](https://wxt.dev/guide/installation.html) to get started with WXT.

## Features

* 🌐 Supports all browsers
* ✅ Supports both MV2 and MV3
* ⚡ Dev mode with HMR & fast reload
* 📂 File based entrypoints
* 🚔 TypeScript
* 🦾 Auto-imports
* 🤖 Automated publishing
* 🎨 Frontend framework agnostic: works with Vue, React, Svelte, etc
* 📦 [Module system](https://wxt.dev/guide/essentials/wxt-modules.html#overview) for reusing code between extensions
* 🖍️ Quickly bootstrap a new project
* 📏 Bundle analysis

## Sponsors

WXT is a [MIT-licensed](https://github.com/wxt-dev/wxt/blob/main/LICENSE) open source project with its ongoing development made possible entirely by the support of these awesome backers. If you'd like to join them, please consider [sponsoring WXT's development](https://github.com/sponsors/wxt-dev).

[![WXT Sponsors](https://raw.githubusercontent.com/wxt-dev/static/refs/heads/main/sponsorkit/sponsors.svg)](https://github.com/sponsors/wxt-dev)

## Contributors

Published under the [MIT](https://github.com/wxt-dev/wxt/blob/main/LICENSE) license.
Made by [@aklinker1](https://github.com/aklinker1) and [community](https://github.com/wxt-dev/wxt/graphs/contributors) 💛

[![WXT contributors](https://contrib.rocks/image?repo=wxt-dev/wxt)](https://github.com/wxt-dev/wxt/graphs/contributors)

***

Generated using [typedoc-plugin-markdown](https://www.npmjs.com/package/typedoc-plugin-markdown) and [TypeDoc](https://typedoc.org/)