amo-upload

Upload your web extension to AMO and get the download URL after being signed.

Note: This package only provides ES module, see here for more details.

Highlights

• Upload zipped extension file
• Optionally upload source code for review
• Idempotent commands, CI friendly
• List all version statuses with a single command

Command-line Usage

The following options can also be loaded from environment variables:

| Global Option | Environment Variable | |--------------------|----------------------| | --api-key | AMO_KEY | | --api-secret | AMO_SECRET | | --api-url-prefix | AMO_URL_PREFIX | | --addon-id | AMO_ADDON_ID |

Note: the command-line options take precedence over the environment variables.

Upload and Sign

$ npx amo-upload \
  sign \
  --api-key $API_KEY \
  --api-secret $API_SECRET \
  --addon-id $ADDON_ID \
  --addon-version $VERSION \
  --channel listed \
  --dist-file path/to/dist.zip \
  --source-file path/to/source.zip
  --output path/to/my-ext-v1.2.3.xpi

For listed channel, we don't wait for the signed package if no output is specified. The output will be the filename of the package.

For unlisted channel, we will wait for the package to be signed. After the signed file is downloaded, the path of the downloaded file will be printed to the console. Otherwise an error will be thrown.

List Statuses

# List all public versions
$ npx amo-upload list

# List all listed and unlisted versions
$ npx amo-upload list --filter all_with_unlisted

See the documentation for more details about filter.

API

import { signAddon } from 'amo-upload';

try {
  const output = await signAddon({
    apiKey,
    apiSecret,
    addonId,
    addonVersion,
    channel: 'listed',
    distFile: 'path/to/dist.zip',
    sourceFile: 'path/to/source.zip',
    output: 'path/to/my-ext-v1.2.3.xpi',
  });
  console.info('The signed file is stored at:', output);
} catch (err) {
  console.error('File not signed yet');
}

References

• addons-server: https://addons-server.readthedocs.io/en/latest/index.html