Skip to content

Init

The init feature is used to create a config file for building extensions.

Prerequisites

Usage

bash
bepp init [options]
js
/**
 * Init config file for build extensions.
 * 
 * @see https://bepp.pigeonposse.com/
 * @see https://bepp.pigeonposse.com/guide/lib/init
 */
import {init} from '@bepp/bepp'

init({/** options **/})

Options

y

Overwrite file if it exists.

  • CLI option: -y
  • JS key: y
  • Type: boolean

id

Identification for build. Used in filename build.

  • CLI option: --id
  • JS key: id
  • Type: string
  • Default: bepp

input

Input directory for Chromium extension.

  • CLI option: -i --input
  • JS key: input
  • Type: string

build

List for browser builds.

  • CLI option: -b --build
  • JS key: build
  • Type: ( chrome | chrome-mv2 | chromium | chromium-mv2 | firefox | firefox-mv2 | yandex | yandex-mv2 | edge | edge-mv2 | safari | safari-mv2 | brave | opera | opera-gx )[]

Examples

bash
bepp init -y --id bepp  -i /path/to/extension --build chrome firefox
js
import {init} from '@bepp/bepp'

init({
    id: 'my-extension-name',
    input: '/path/to/extension',
    build: ['chrome', 'firefox']
})

This command will create a config file for building an extension with the specified options.