Getting Started

このプラグインのインストールステップとフルマークダウンガイドまで含む設定プロンプトをコピーする。

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-patch`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/capacitor-patch/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

Install

You can use our AI-Assisted Setup to install the plugin. Add the Capgo skills to your AI tool using the following command:

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

Then use the following prompt:

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

If you prefer Manual Setup, install the plugin by running the following commands and follow the platform-specific instructions below:

npm install @capgo/capacitor-patch
npx cap sync

The package is a no-op until you select patches in your Capacitor config.

patch IDを選択

配信済みのすべてのパッチを表示

npx capgo-capacitor-patch list --all

あなたのアプリに必要なpatch IDを追加してください capacitor.config.ts:

import type { CapacitorConfig } from '@capacitor/cli';

const config: CapacitorConfig = {
  appId: 'com.example.app',
  appName: 'Example',
  webDir: 'dist',
  plugins: {
    CapacitorPatch: {
      patches: ['upstream-pr-8418-android'],
      strict: true,
    },
  },
};

export default config;

syncを実行してください

npx cap sync

パッケージパッチは先に実行されます sync そして update. sync 原生プロジェクトのパッチは update.

と

セクションのタイトル： “Dry-runの適用前に” doctor を使用して

npx capgo-capacitor-patch doctor --phase package --strict

コピー apply を使用して

npx capgo-capacitor-patch apply --phase package

設定オプション

オプション	タイプ	デフォルト	説明
`recommended`	`boolean`	`false`	Capgo マークのパッチを推奨します。
`patches`	`string[]`	`[]`	明示的なパッチ ID を適用します。
`disabled`	`string[]`	`[]`	推奨されているパッチ ID を除外します。
`strict`	`boolean`	`false`	選択したパッチが不一致または適用できない場合に例外を投げます。

CLIコマンドのセクション

npx capgo-capacitor-patch list --all
npx capgo-capacitor-patch doctor
npx capgo-capacitor-patch apply

アプリケーションルートを設定します。

--root <dir> 修正のフェーズの実行を制限します。
--phase package|native|all プラットフォームのフィルタリングを__CAPGO_KEEP_0__ホックの外側で適用します。
--platform ios|android applies platform filtering outside a Capacitor hook.
--strict ワークフロー

ワークフロー

インストール @capgo/capacitor-patch.
実行 npx capgo-capacitor-patch list --all.
選択したパッチIDを追加 plugins.CapacitorPatch.patches.
実行 npx capgo-capacitor-patch doctor --strict.
実行 npx cap sync.

選択したパッチがインストールされている__CAPGO_KEEP_0__パッケージと次の @capacitor/cliコマンドはパッチされたCLI __CAPGO_KEEP_1__を使用します。 cap command uses the patched CLI code.

Getting Startedから続けて

あなたがCloudflare、Capacitor、GitHub、Capgo、code、API、SDK、CLI、npm、bunを使用している場合 始め方 nativeプラグインの作業を計画するには、を接続する必要があります。 @capgo/capacitor-patchを使用する @capgo/capacitor-patchを使用するnative機能について Capgo プラグインディレクトリ Capgo プラグインディレクトリの製品ワークフローについて Capacitor プラグインをCapgoで Capacitor プラグインをCapgoで実装の詳細についてプラグインの追加または更新プラグインの追加または更新の実装の詳細について、 Ionic Enterprise プラグインの代替 Ionic Enterprise プラグインの代替の製品ワークフローについて