Electron Updaterの導入

このガイドでは、ElectronアプリケーションにLive JavaScript/HTML/CSS更新を有効にするために設定する方法について説明します。 @capgo/electron-updater ヒント

__CAPGO_KEEP_0__と__CAPGO_KEEP_1__を既に使用している場合、Electron Updaterは同じ__CAPGO_KEEP_2__ Cloudバックエンドを使用するため、両方のモバイルとデスクトップアプリを同じダッシュボードから管理できます。

Already using Capgo with Capacitor? The Electron Updater uses the same Capgo Cloud backend, so you can manage both mobile and desktop apps from the same dashboard.

前提条件

• Node.js 18 またはそれ以上
• protectedTokens
• A Capgo アカウント ( capgo.app)

インストール

AI-Assisted セットアップを使用してプラグインをインストールできます。AI ツールに Capgo スキルを追加するには、以下のコマンドを実行してください:

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

次に、以下のプロンプトを使用してください:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/electron-updater` plugin in my project.

Manual Setup を使用する場合は、以下のコマンドを実行してプラグインをインストールし、以下のプラットフォーム固有の指示に従ってください:

1. パッケージをインストール:

   bun add @capgo/electron-updater

2. CapgoのCapgoダッシュボードからアプリIDを取得してください。アプリを作成していない場合は、以下のコマンドを実行してください。

   npx @capgo/cli@latest init

セットアップ

Capgo Builder / ネイティブクラウドビルド製品ページ

セットアップ

メインプロセス

import { app, BrowserWindow } from 'electron';
import * as path from 'path';
import {
  ElectronUpdater,
  setupIPCHandlers,
  setupEventForwarding,
} from '@capgo/electron-updater';

// Create updater instance with your Capgo App ID
const updater = new ElectronUpdater({
  appId: 'YOUR_CAPGO_APP_ID', // e.g., 'com.example.myapp'
  autoUpdate: true,
});

app.whenReady().then(async () => {
  const mainWindow = new BrowserWindow({
    width: 1200,
    height: 800,
    webPreferences: {
      preload: path.join(__dirname, 'preload.js'),
      contextIsolation: true,
    },
  });

  // Initialize updater with window and builtin path
  const builtinPath = path.join(__dirname, 'www/index.html');
  await updater.initialize(mainWindow, builtinPath);

  // Setup IPC communication between main and renderer
  setupIPCHandlers(updater);
  setupEventForwarding(updater, mainWindow);

  // Load the current bundle (either builtin or downloaded update)
  await mainWindow.loadFile(updater.getCurrentBundlePath());
});

app.on('window-all-closed', () => {
  if (process.platform !== 'darwin') {
    app.quit();
  }
});

main.ts

preload.ts

import { exposeUpdaterAPI } from '@capgo/electron-updater/preload';

// Expose the updater API to the renderer process
exposeUpdaterAPI();

レンダラー プロセス

// renderer.ts (or in your app's entry point)
import { requireUpdater } from '@capgo/electron-updater/renderer';

const updater = requireUpdater();

// CRITICAL: Call this on every app launch!
// This confirms the bundle loaded successfully and prevents rollback
await updater.notifyAppReady();

console.log('App ready, current bundle:', await updater.current());

注意

あなたは configurable via を呼び出す必要があります notifyAppReady() 10秒以内にアプリケーション起動 (configurable via appReadyTimeout. If not called, the updater assumes the update failed and rolls back to the previous version.

アップデートの確認

自動でアップデートの確認を行います。 autoUpdate: trueCopy to clipboard

// Check for updates manually
const latest = await updater.getLatest();

if (latest.url && !latest.error) {
  console.log('Update available:', latest.version);

  // Download the update
  const bundle = await updater.download({
    url: latest.url,
    version: latest.version,
    checksum: latest.checksum,
  });

  console.log('Downloaded bundle:', bundle.id);

  // Option 1: Queue for next restart
  await updater.next({ id: bundle.id });

  // Option 2: Apply immediately and reload
  // await updater.set({ id: bundle.id });
}

Section titled “Listening to Events”

Copy to clipboard

// Download progress
updater.addListener('download', (event) => {
  console.log(`Download progress: ${event.percent}%`);
});

// Update available
updater.addListener('updateAvailable', (event) => {
  console.log('New version available:', event.bundle.version);
});

// Download completed
updater.addListener('downloadComplete', (event) => {
  console.log('Download finished:', event.bundle.id);
});

// Update failed
updater.addListener('updateFailed', (event) => {
  console.error('Update failed:', event.bundle.version);
});

Section titled “Deploying Updates”

Capgo CLI を使用してアップデートをアップロードします:

# Build your app
npm run build

# Upload to Capgo
npx @capgo/cli@latest bundle upload --channel=production

あなたの Electron アプリケーションは、次のチェックで新しいバンドルを自動的に検出してダウンロードします。

デバッグメニュー

開発中はデバッグメニューを有効にします:

const updater = new ElectronUpdater({
  appId: 'YOUR_CAPGO_APP_ID',
  debugMenu: true, // Enable debug menu
});

「 Ctrl+Shift+D 」または「(Mac)」を押すと、デバッグメニューが開き、以下の情報を表示します。 Cmd+Shift+D 現在のバンドル情報を表示

• __CAPGO_KEEP_0__ __CAPGO_KEEP_1__
• バンドルを切り替えます
• バーンバックを実行します
• デバイスとチャンネル情報を表示

設定オプション

const updater = new ElectronUpdater({
  // Required
  appId: 'com.example.app',

  // Server URLs (defaults to Capgo Cloud)
  updateUrl: 'https://plugin.capgo.app/updates',
  channelUrl: 'https://plugin.capgo.app/channel_self',
  statsUrl: 'https://plugin.capgo.app/stats',

  // Behavior
  autoUpdate: true,           // Enable auto-updates
  appReadyTimeout: 10000,     // MS before rollback (default: 10s)
  autoDeleteFailed: true,     // Delete failed bundles
  autoDeletePrevious: true,   // Delete old bundles after successful update

  // Channels
  defaultChannel: 'production',

  // Security
  publicKey: '...',           // For end-to-end encryption

  // Debug
  debugMenu: false,           // Enable debug menu
  disableJSLogging: false,    // Disable console logs

  // Periodic Updates
  periodCheckDelay: 0,        // Seconds between checks (0 = disabled, min 600)
});

次のステップ

• API リファレンス 利用可能なすべてのメソッドを探索
• チャンネル デプロイメントチャンネルについて学びます
• ロールバック - ロールバック保護の理解

Electron UpdaterのGetting Startedから続けて

Capacitorを使用している場合 Electron UpdaterのGetting Started Capacitorを使用してネイティブプラグインの作業を計画する場合、@__CAPGO_KEEP_0__/electron-updater Capacitorのネイティブ機能を使用するには@capgo/electron-updater capgo プラグインディレクトリ Capacitorの製品ワークフローを使用するにはCapgo プラグインディレクトリ Capgo Capacitor プラグイン Capacitor Plugins by Capgo Capgoの実装詳細についてはCapacitorプラグインによってCapgoで プラグインの追加または更新 Capgoの実装詳細についてはプラグインの追加または更新、 Ionic Enterpriseプラグインの代替 Capgoの製品ワークフローについてはIonic Enterpriseプラグインの代替