Skip to content
Get packs

Guide · Open source

How to use Plasmo: build browser extensions with TypeScript

Updated · written with AI from the project's own documentation and checked against our catalogue data

Plasmo is an open-source framework for building browser extensions, the small add-ons that run inside browsers such as Chrome, Firefox and Edge. It is written in TypeScript and aimed at developers who want a structured setup instead of wiring up a bundler and manifest by hand. This guide explains what the project is, who it suits, and the one install step the source material confirms, and it is honest about what the source leaves unverified.

PlasmoPlasmoHQ/plasmo · ★ 13.2k · MIT

Quick start

  1. 1Confirm it fits your project. Check that you are building a browser extension for Chrome, Firefox or Edge and that TypeScript suits your team.
  2. 2Clone the repository. Run the git clone command from the source to get the Plasmo code locally.
  3. 3Open the homepage. Visit https://www.plasmo.com to find setup and usage documentation.
  4. 4Check the license. Confirm the MIT license terms in the repository before you use it in your project.
  5. 5Compare alternatives. Review WXT and CRXJS, the comparable projects listed, if you want to weigh options.

What Plasmo is and who it is for

Plasmo is a framework for building browser extensions. Browser extensions are small add-ons that run inside browsers like Chrome, Firefox and Edge.

It is a good fit for developers building an extension for Chrome, Firefox or Edge, teams that want a TypeScript-based extension setup, and developers who already work with React and want to use it in an extension.

  • Developers building a browser extension for Chrome, Firefox or Edge
  • Teams who want a TypeScript-based extension setup
  • Developers who already work with React

What Plasmo is not for

Plasmo is a developer framework. If you only want to use an existing extension rather than build one, it is not the right tool.

The source README was empty in the supplied material, so documented behavior for specific features could not be verified. Check the official homepage before relying on any particular feature.

  • People who only want to use an existing extension
  • Developers who need documented behavior for specific features, since the README could not be checked

Get the Plasmo source code

The only install command in the source material clones the repository from GitHub. The source lists the install method as a package manager, but it does not provide package-manager commands, so none are shown here.

The source lists no prerequisites.

git clone https://github.com/PlasmoHQ/plasmo

Find the official documentation

The project homepage is listed as https://www.plasmo.com. Because the README in the supplied material was empty, use the homepage and the repository itself to find setup steps, configuration details and feature documentation.

Plasmo is licensed under the MIT license, according to the repository metadata.

  • Homepage: https://www.plasmo.com
  • Repository: https://github.com/PlasmoHQ/plasmo

Compare Plasmo with similar projects

Comparable projects listed for Plasmo are WXT and CRXJS. The source does not include a feature-by-feature comparison, so compare them using their own documentation and your project needs.

  • WXT
  • CRXJS

What people use it for

  • Building a browser extension for Chrome, Firefox or Edge in TypeScript
  • Setting up an extension project with a structured layout instead of a hand-wired bundler and manifest
  • Adding a React-based interface to a browser extension

Frequently asked questions

Is Plasmo free to use?

The repository metadata lists the MIT license. Read the license file in the repository to confirm the terms for your own use.

What are the requirements for Plasmo?

The source material lists no prerequisites. Check the homepage at https://www.plasmo.com for setup requirements in the official documentation.

How do I install Plasmo?

The source confirms one command: git clone https://github.com/PlasmoHQ/plasmo. The source lists a package-manager install method but does not provide those commands, so check the official homepage for them.

What are alternatives to Plasmo?

The comparable projects listed are WXT and CRXJS. Compare them based on their documentation and your needs.

Does Plasmo support React?

The source says Plasmo suits developers who already work with React and want to use it in an extension. The README was empty, so check the official docs for details.

Why can't I find detailed Plasmo documentation in the repository?

The README was empty in the supplied material, so feature details could not be verified. Use the homepage at https://www.plasmo.com for documentation.

New agent skills, repos and AI tools — every week

The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.

Our verdict

Plasmo is worth a look if you are a developer who wants a structured, TypeScript-based way to build a browser extension, especially with React. If you only want to use existing extensions, or you need detailed, verified feature documentation from the repository itself, pick another option or check the official homepage first, since the README was unavailable for this review.

Install options & downloads