Project Management

/**
 * Initialize a new Electron application
 * Usage: electron-forge init [dir] [options]
 */
interface InitOptions {
  /** Directory to initialize the project in */
  dir: string;
  /** Enable interactive prompts */
  interactive: boolean;
  /** Whether to copy the templated CI files */
  copyCIFiles?: boolean;
  /** Whether to overwrite an existing directory */
  force?: boolean;
  /** Skip initializing a git repository in the initialized project */
  skipGit?: boolean;
  /** Name of the Forge template to use */
  template?: string;
}

# Initialize in current directory with default template
electron-forge init

# Initialize in specific directory
electron-forge init my-electron-app

# Use specific template
electron-forge init --template=webpack-typescript

# Copy CI files and force overwrite
electron-forge init --copy-ci-files --force

# Skip git initialization
electron-forge init --skip-git

/**
 * Import an existing Electron project to Forge
 * Usage: electron-forge import [dir] [options]
 */
interface ImportOptions {
  /** Directory of the project to import */
  dir: string;
  /** Enable interactive prompts */
  interactive: boolean;
  /** Skip initializing a git repository in the imported project */
  skipGit?: boolean;
}

# Import current directory
electron-forge import

# Import specific directory
electron-forge import /path/to/existing/electron/app

# Import without git initialization
electron-forge import --skip-git

/**
 * Core API functions called by CLI commands
 */
interface ForgeAPI {
  init(options: InitOptions): Promise<void>;
  import(options: ImportOptions): Promise<void>;
}