crx-util

Download (and extract) Chrome/Edge extension (.crx).

Install

1npm install crx-util

Usage

1const crx = require("crx-util");
2
3// Download a CRX file from microsoft webstore
4crx.downloadByURL(`https://microsoftedge.microsoft.com/addons/detail/${extensionName}/${extensionId}`, "./xxx.crx")
5  .then((res) => {
6    if (res.result) {
7      console.info("succeed!");
8    } else {
9      console.warn("Failed:", res.error);
10    }
11    // Other info
12    const { extensionId, source, downloadURL, output } = res;
13  });
14
15// Download by extension id and source
16crx.downloadById(`${extensionId}`, "edge", "./xxx.crx");
17
18// Download and extract
19crx.downloadById(`${extensionId}`, "edge", "./xxx");
20
21// Download from google webstore
22crx.downloadByURL(`https://chrome.google.com/webstore/detail/${extensionName}/${extensionId}`, "./xxx.crx");
23
24// Or by extension id and source
25crx.downloadById(`${extensionId}`, "chrome", "./xxx.crx");
26
27// Extract a local CRX file
28crx.parser.extract("./xxx.crx", "./xxx");

CLI

Usage

1# Download by webstore url
2crx-util -u=url [-o=output]
3
4# Download by extension id and source
5crx-util -i=extensionId -s=source [-o=output]
6
7# Extract a local CRX file
8Usage: crx-util -e=crxPath [-o=output]

Example:

1# Download a CRX file from microsoft webstore
2crx-util -u="https://microsoftedge.microsoft.com/addons/detail/$name/$id" -o="./xxx.crx"
3
4# Download and extract
5crx-util -i="$id" -s="edge" -o="./xxx"
6
7# Extract a local CRX file
8crx-util -e="./xxx.crx" -o="./xxx"

Arguments

• -u, --url - Chrome/Edge extension url
• -i, --id - Extension id
• -s, --source - Extension source, "chrome" or "edge"
• -e, --extract - Extract a local CRX file
• -o, --output - Output, if it ends with .crx, it will be saved as a CRX file, otherwise it will be extracted to ${output}/${extensionId}. Default by process.cwd().
• -h, --help - Display help for command

API

crx.downloadByURL(url, output?): Promise

Download a CRX file from webstore.

• url string - Chrome/Edge extension url
• output string (optional) - If output ends with ".crx", it will be saved as a CRX file, otherwise it will be extracted to ${output}/${extensionId}. Default by process.cwd().

Resolves with an object contains the following info:

• result Boolean
• error any
• extensionId String
• source "chrome" | "edge"
• downloadURL String
• output String

crx.downloadById(extensionId, source, output?): Promise

Download a CRX file by extension id and source.

• extensionId string - Extension id
• source "chrome" | "edge" - Extension source
• output string (optional) - If output ends with ".crx", it will be saved as a CRX file, otherwise it will be extracted to ${output}/${extensionId}. Default by process.cwd().

Resolves with an object.

crx.downloader

crx.downloader.URL_PATTERN

Download url pattern.

• chrome string
• edge string

crx.downloader.parseURL(url): Object

Parse Chrome/Edge extension url.

• url string - Chrome/Edge extension url.

Returns an object contains extensionId and source ("chrome" or "edge") info.

crx.downloader.getDownloadURL(extensionId, source): String

Get download url by extensionId and source.

• extensionId string - Extension id
• source "chrome" | "edge" - Extension source

Returns the download url.

crx.downloader.downloadByURL(url): Promise

Download a CRX file by url.

• url string - Chrome/Edge extension url.

Resolves with CRX buffer.

crx.downloader.downloadById(extensionId, source): Promise

Download a CRX file by extension id and source.

• extensionId string - Extension id
• source "chrome" | "edge" - Extension source

Resolves with CRX buffer.

crx.parser

crx.parser.isCrx(crxPathOrBuffer): Boolean

Checks whether the given path or Buffer contains a valid CRX file.

• crxPathOrBuffer string | Buffer - CRX file path or buffer.

crx.parser.getCrxVersion(crxPathOrBuffer): Number

Get CRX version.

• crxPathOrBuffer string | Buffer - CRX file path or buffer.

crx.parser.getZipContents(crxPathOrBuffer): Buffer

Convert a CRX Buffer to a Zip Buffer.

• crxPathOrBuffer string | Buffer - CRX file path or buffer.

crx.parser.extract(crxPathOrBuffer, output?)

Extract a local CRX file.

• crxPathOrBuffer string | Buffer - CRX file path or buffer.
• output string (optional) - It will be extracted to ${output}/${crxFileName}. Default by process.cwd().