agentleFS
Sign inStart free
full-stack-skillsfull-stack-skills/electron-skills/skills/electron/SKILL.md

electron

Skill8 starsChanged 54 days agoApache-2.0View on GitHub

Provides comprehensive guidance for Electron framework including main process, renderer process, IPC communication, window management, and desktop app development. Use when the user asks about Electron, needs to create desktop applications, implement Electron features, or build cross-platform desktop apps.

21 other projects use a version of this, 2 of them edited.

Adopted by

Most recently taken up by

Used with

Projects with it also use dep-refs, feature-boundary-planner and 6 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • betacatslingSkill

    dep-refs

    Use when needs to inspect TypeScript export references in the z-code workspace, list exports from a file, verify whether an export is unused before deletion, investigate who imports a symbol during refactors, or combine pnpm knip unused-export results with pnpm dep:refs symbol-level reference tracing.

    Also in 5 projects that use this

  • betacatslingSkill

    feature-boundary-planner

    Map a ZCode behavior change to current UI surfaces, state owners, protocol commands, persistence, and validation. Use for impact analysis, product-boundary planning, or an implementation handoff grounded in the checked-out source.

    Also in 5 projects that use this

  • Cartograf666Skill

    architecture-governance

    Bootstrap, document, enforce, and review a project's architecture through layer responsibilities, dependency direction, architecture manifests, legacy baselines, Change Envelopes, cross-layer approval policy, and deterministic architecture checks. Use when starting a project, auditing an existing codebase, planning cross-layer work, preventing architecture erosion, reviewing structural changes, or deciding whether implementation may expand into another layer.

    Also in 5 projects that use this

  • ZCodium-projectSkill

    e2e-case-lifecycle

    Plan, maintain, replay, and promote ZCode desktop E2E cases and their fixtures, coverage matrices, and CI admission evidence.

    Also in 3 projects that use this

  • ZCodium-projectSkill

    zcode-large-task-fixture

    Generate, verify, or remove large synthetic ZCode task fixtures in local ~/.zcode persistence for UI/session performance testing. Use when testing big conversation/task rendering, task list performance, snapshot recovery, tool-call rendering, reasoning, patches, todos, and model usage without spending time chatting manually.

    Also in 3 projects that use this

  • VercelSkill

    ai-elements

    Build AI chat interfaces using ai-elements components — conversations, messages, tool displays, prompt inputs, and more. Use when the user wants to build a chatbot, AI assistant UI, or any AI-powered chat interface.

    Also in 5 projects that use this

The file

Show its rules and text

We split this skill into the rules it gives an agent

13 rules. 0 are common, 12 are distinctive, and 1 is very specific to this project.

  • 0

    Common

    Most of the 21 edited versions we read keep these.

  • 12

    Distinctive

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Use this skill whenever the user wants to:

    line 8
  2. Distinctive:

    Create and manage BrowserWindow instances

    line 12
  3. Distinctive:

    Use Electron Forge for project scaffolding and building

    line 15
  4. Distinctive:

    Use Electron APIs (app, BrowserWindow, ipcMain, ipcRenderer, etc.)

    line 18
  5. Distinctive:

    All examples follow Electron latest API

    line 67
  6. Distinctive:

    Always check the example file for best practices and common patterns

    line 70
  7. Distinctive:

    Follow the instructions, syntax, and best practices in that file

    line 99
  8. Very specific:

    All API files include links to relevant example files in the examples/ directory

    line 124
  9. Distinctive:

    Security: Never enable nodeIntegration in renderer process, use preload scripts

    line 128
  10. Distinctive:

    Process separation: Keep main and renderer processes separate

    line 129
  11. Distinctive:

    IPC communication: Use IPC for safe communication between processes

    line 130
  12. Distinctive:

    Packaging: Use Electron Forge or electron-builder for packaging

    line 134
  13. Distinctive:

    Cross-platform: Test on all target platforms

    line 137

“Common” is measured: kept by at least 6 in 10 of the 21 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

When to use this skill

Use this skill whenever the user wants to:

  • Build cross-platform desktop applications with Electron
  • Understand Electron architecture (main process, renderer process, preload)
  • Implement IPC (Inter-Process Communication) between processes
  • Create and manage BrowserWindow instances
  • Implement menus, tray icons, and native features
  • Package and distribute Electron applications
  • Use Electron Forge for project scaffolding and building
  • Debug and test Electron applications
  • Implement security best practices
  • Use Electron APIs (app, BrowserWindow, ipcMain, ipcRenderer, etc.)

How to use this skill

This skill is organized to match the Electron official documentation structure (https://www.electronjs.org/zh/docs/latest/, https://www.electronjs.org/zh/docs/latest/api/app). When working with Electron:

  1. Identify the topic from the user's request:
    • Getting started/快速开始 → examples/getting-started/installation.md or examples/getting-started/quick-start.md
    • Main process/主进程 → examples/processes/main-process.md
    • Renderer process/渲染进程 → examples/processes/renderer-process.md
    • IPC communication/IPC 通信 → examples/processes/ipc-communication.md
    • BrowserWindow/窗口 → examples/api/browser-window.md
    • Menu/菜单 → examples/api/menu.md
    • Packaging/打包 → examples/advanced/packaging.md
    • Security/安全 → examples/advanced/security.md

  2. Load the appropriate example file from the examples/ directory:

    Getting Started (快速开始) - examples/getting-started/:

    • examples/getting-started/installation.md - Installing Electron and basic setup
    • examples/getting-started/quick-start.md - Quick start tutorial

    Processes (进程) - examples/processes/:

    • examples/processes/main-process.md - Main process concepts and usage
    • examples/processes/renderer-process.md - Renderer process concepts
    • examples/processes/preload-scripts.md - Preload scripts usage
    • examples/processes/ipc-communication.md - IPC communication patterns

    API Examples (API 示例) - examples/api/:

    • examples/api/browser-window.md - BrowserWindow usage
    • examples/api/menu.md - Menu and context menu
    • examples/api/tray.md - System tray
    • examples/api/dialog.md - File dialogs
    • examples/api/ipc-main.md - ipcMain usage
    • examples/api/ipc-renderer.md - ipcRenderer usage

    Advanced (高级) - examples/advanced/:

    • examples/advanced/packaging.md - Application packaging
    • examples/advanced/security.md - Security best practices
    • examples/advanced/auto-updater.md - Auto updater
    • examples/advanced/native-modules.md - Native modules

    Tools (工具) - examples/tools/:

    • examples/tools/electron-forge.md - Electron Forge usage
    • examples/tools/electron-fiddle.md - Electron Fiddle usage

  3. Follow the specific instructions in that example file for syntax, structure, and best practices

    Important Notes:

    • All examples follow Electron latest API
    • Examples use both CommonJS (require) and ES modules (import)
    • Each example file includes key concepts, code examples, and key points
    • Always check the example file for best practices and common patterns
    • Electron supports Windows, macOS, and Linux
  4. Reference API documentation in the api/ directory when needed:
    • api/app.md - app module API
    • api/browser-window.md - BrowserWindow API
    • api/ipc-main.md - ipcMain API
    • api/ipc-renderer.md - ipcRenderer API
    • api/menu.md - Menu API
    • api/tray.md - Tray API
  5. Use templates from the templates/ directory:
    • templates/main-process.md - Main process template
    • templates/preload-script.md - Preload script template
    • templates/renderer-process.md - Renderer process template
    • templates/package-json.md - package.json template

Doc mapping (one-to-one with official documentation)

Examples and Templates

This skill includes detailed examples organized to match the official documentation structure. All examples are in the examples/ directory (see mapping above).

To use examples:

  • Identify the topic from the user's request
  • Load the appropriate example file from the mapping above
  • Follow the instructions, syntax, and best practices in that file
  • Adapt the code examples to your specific use case

To use templates:

  • Reference templates in templates/ directory for common scaffolding
  • Adapt templates to your specific needs and coding style

API Reference

Detailed API documentation is available in the api/ directory, organized to match the official Electron API documentation structure:

Core APIs (api/)

  • api/app.md - app module API
  • api/browser-window.md - BrowserWindow API
  • api/ipc-main.md - ipcMain API
  • api/ipc-renderer.md - ipcRenderer API
  • api/menu.md - Menu API
  • api/tray.md - Tray API
  • api/dialog.md - Dialog API

To use API reference:

  1. Identify the API you need help with
  2. Load the corresponding API file from the api/ directory
  3. Find the API signature, parameters, return type, and examples
  4. Reference the linked example files for detailed usage patterns
  5. All API files include links to relevant example files in the examples/ directory

Best Practices

  1. Security: Never enable nodeIntegration in renderer process, use preload scripts
  2. Process separation: Keep main and renderer processes separate
  3. IPC communication: Use IPC for safe communication between processes
  4. Resource management: Properly clean up resources (windows, listeners)
  5. Error handling: Implement proper error handling and crash reporting
  6. Performance: Optimize for performance, use webContents for debugging
  7. Packaging: Use Electron Forge or electron-builder for packaging
  8. Auto updates: Implement auto-updater for production apps
  9. Native modules: Handle native module compatibility
  10. Cross-platform: Test on all target platforms

Resources

Keywords

Electron, desktop app, main process, renderer process, preload, IPC, BrowserWindow, Menu, Tray, Dialog, packaging, electron-builder, electron-forge, electron-fiddle, cross-platform, 桌面应用, 主进程, 渲染进程, IPC 通信, 窗口, 菜单, 托盘, 打包

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free