tessl/npm-electron-forge--cli

A complete tool for building modern Electron applications

—

Pending

Quality

Pending

Does it follow best practices?

Impact

Pending

No eval scenarios have been run

Securityby

Pending

The risk profile of this skill

Overview

Eval results

Files

Project Management

Name: tessl/npm-electron-forge--cli
Author: tessl

Core commands for creating and importing Electron projects with template support and configuration options.

Capabilities

Init Command

Initialize a new Electron application with template support and configuration options.

/**
 * 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;
}

Command Line Usage:

# 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

Command Options:

[dir] - Directory to initialize the project in (default: current directory)
-t, --template [name] - Name of the Forge template to use (default: 'base')
-c, --copy-ci-files - Whether to copy the templated CI files (default: false)
-f, --force - Whether to overwrite an existing directory (default: false)
--skip-git - Skip initializing a git repository in the initialized project (default: false)

Import Command

Import an existing Electron project to Forge configuration system.

/**
 * 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;
}

Command Line Usage:

# 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

Command Options:

[dir] - Directory of the project to import (default: current directory)
--skip-git - Skip initializing a git repository in the imported project (default: false)

Types

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

Install with Tessl CLI

npx tessl i tessl/npm-electron-forge--cli

docs

build-distribution.md

development-workflow.md

index.md

project-management.md

utilities.md

tile.json

tessl/npm-electron-forge--cli