Interface InitOptions

interface InitOptions {
    copyCIFiles?: boolean;
    dir?: string;
    electronVersion?: string;
    force?: boolean;
    interactive?: boolean;
    skipGit?: boolean;
    template?: string;
}

Properties

copyCIFiles? dir? electronVersion? force? interactive? skipGit? template?

Properties

Optional copyCIFiles

copyCIFiles?: boolean

Whether to copy template CI files

Optional dir

dir?: string

The path to the app to be initialized

Optional electronVersion

electronVersion?: string

Set a specific Electron version for your Forge project. Can take in version numbers or latest, beta, or nightly.

Default Value

The latest tag on npm.

Optional force

force?: boolean

Whether to overwrite an existing directory

Optional interactive

interactive?: boolean

Whether to use sensible defaults or prompt the user visually

Optional skipGit

skipGit?: boolean

By default, Forge initializes a git repository in the project directory. Set this option to true to skip this step.

Optional template

template?: string

The custom template to use. If left empty, the default template is used

Settings

Member Visibility

Theme

On This Page

copyCIFilesdirelectronVersionforceinteractiveskipGittemplate