Skip to content

guocaoyi/create-chrome-ext

main
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Create Chrome Extension (.crx)

crx-preview OSCS Status npm npm-download GitHub Language Count npm publish

Scaffolding your chrome extension, multiple boilerplates supported!

English绠浣撲腑鏂French頃滉淡鞏Indonesian袪褍褋褋泻懈泄Deutsch鏃ユ湰瑾 (by ChatGPT)

Installing

Node >= 14.18.0

# use npm-create command, or use pnpm | yarn
位 npm create chrome-ext

# or use npx command
位 npx create-chrome-ext

# or use npm-init command
位 npm init chrome-ext

Usage

You can also directly specify the project name and the template you want to use via additional command line options. For example, to scaffold a Vite + Svelte project, run:

# npm 6.x
位 npm create chrome-ext@latest my-crx-app --template svelte-js

# or npm 7+, extra double-dash is needed:
位 npm create chrome-ext@latest my-crx-app -- --template react-ts

# or yarn
位 yarn create chrome-ext my-crx-app --template vue-ts

# or pnpm
位 pnpm create chrome-ext my-crx-app --template vanilla-ts

You can also generator the project with crx cli, run:

位 npm install create-chrome-ext --global

# and then
位 crx my-crx-app
# or
位 crx my-crx-app --template preact-js
# or use create-chrome-exe (global env)
位 create-chrome-ext my-crx-app

Preview

crx-run crx-install crx-build