Getting started

Install Addonova, scaffold a project, and run a first build.

#

Requirements

#
  • Node.js 20 or newer.
  • A Chromium browser, Microsoft Edge, or Firefox for addonova dev.

Install

#

Add Addonova to a project:

npm install --save-dev addonova
npm install @addonova/browser

Or scaffold a complete project:

npx addonova init my-extension
cd my-extension
npm install

Bundled templates are vanilla-ts, vanilla-js, and react. Use a remote template with a gh: source:

npx addonova init my-extension --template gh:owner/repo/path#ref

First build

#
npx addonova build

By default the build targets Chrome with Manifest V3 and writes to dist/chrome/:

dist/
└── chrome/
    ├── manifest.json
    ├── background.js
    └── ...

Build several targets:

npx addonova build --browser chrome --browser firefox

Development

#
npx addonova dev

dev watches the project, rebuilds on change, launches each configured browser, and reloads the extension after successful rebuilds.

Package

#
npx addonova pack

Archives are written beside the output unless pack.outFile is configured. For Firefox review, add --sources or set pack.sources.

Next: Core concepts.

Edit this page on GitHub