wxt README

The project's README from github.com/wxt-dev/wxt. As one markdown file: README.md.

WXT Logo WXT

npm version downloads license | MIT coverage

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

Get Started • Configuration • Examples • Changelog • Discord

Example CLI Output

Demo

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

Quick Start

Bootstrap a new project:

# npm
npx wxt@latest init

# pnpm
pnpm dlx wxt@latest init

# bun
bunx wxt@latest init

Or see the installation guide to get started with WXT.

Features

Sponsors

WXT is a MIT-licensed 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.

WXT Sponsors

Contributors

Published under the MIT license. Made by @aklinker1 and community 💛

WXT contributors

wxt (wxt-dev/wxt)

Searching Database…

10.6K ·GitHub
What is this?WXT is an open-source framework for building web browser extensions — the self-description is 'like Nuxt, but for Web Extensions'.
So is it an app I install, or a framework I build my extension on?A framework you build on, not an end-user app: your extension is a project written on top of WXT, following conventions like defining entrypoints as files.
How do I start my first extension with it?Bootstrap a new project with the Quick Start command from the README, or follow the installation guide. In dev mode you get HMR and fast reload instead of manual rebuilds.
Do I have to build the UI with a particular framework?No — it is frontend framework agnostic: Vue, React, Svelte and others all work. TypeScript is first-class too, with auto-imports built in.
Will it lock me into Chrome, or can I target other browsers too?You are not locked in: WXT supports all browsers and both Manifest V2 and V3.
Is it free to use, or is there a paid tier?Fully free and open source under the MIT license; ongoing development is funded by sponsors and backers.
Can it publish my extension to the stores?Yes — automated publishing is one of WXT's core features, and a bundle analysis tool helps you inspect the package before release.
What is the module system for?Modules let you reuse code between extensions: package shared functionality once and plug it into any WXT project instead of copy-pasting it.
What are similar projects?razzle, vite, moveable, todomvc, taro, mitosis, plasmo, openui
Creator
wxt-dev
Size
11.3 MB
Stars
10.6K
Age
3y
Commits · 90 Days