Installation ​

Bootstrap a new project, start from scratch, or migrate an existing project.

Bootstrap Project ​

Run the init command, and follow the instructions.

pnpm dlx wxt@latest init

# Use NPM initially, but select Yarn when prompted
npx wxt@latest init

Demo ​

Once you've run the dev command, continue to Next Steps!

From Scratch ​

1. Create a new project

   PNPMBunNPMYarn

   sh

   cd my-project
   pnpm init

   sh

   cd my-project
   yarn init

2. Install WXT:

3. Add an entrypoint, my-project/entrypoints/background.ts:

   ts

   ts

   export default defineBackground(() => {
     console.log('Hello world!');
   });

4. Add scripts to your package.json:

   package.json

   json

   {
     "scripts": {
       "dev": "wxt", 
       "dev:firefox": "wxt -b firefox", 
       "build": "wxt build", 
       "build:firefox": "wxt build -b firefox", 
       "zip": "wxt zip", 
       "zip:firefox": "wxt zip -b firefox", 
       "postinstall": "wxt prepare"
     }
   }

5. Run your extension in dev mode

   WXT will automatically open a browser window with your extension installed.

Next Steps ​

• Keep reading on about WXT's Project Structure and other essential concepts to learn
• Configure automatic browser startup during dev mode
• Explore WXT's example library to see how to use specific APIs or perform common tasks
• Checkout the community page for a list of resources made by the community!