开始教程

复制一个包含安装步骤和本插件的完整 Markdown 指南的配置提示。

        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.

安装

您可以使用我们的AI辅助设置来安装插件。使用以下命令将Capgo技能添加到您的AI工具中：

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/capacitor-patch` plugin in my project.

如果您更喜欢手动设置，请运行以下命令并按照以下平台特定的说明进行操作：

npm install @capgo/capacitor-patch
npx cap sync

包是直到您在Capacitor配置中选择补丁时才会执行的。

选择补丁ID

List all shipped patches:

npx capgo-capacitor-patch list --all

然后添加您的应用程序需要的修补程序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;

再次运行同步:

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 限制哪个修复阶段运行。
--platform ios|android 在Capacitor钩子外应用平台过滤。
--strict 将选定的修复错误视为错误。

工作流

安装 @capgo/capacitor-patch.
运行 npx capgo-capacitor-patch list --all.
将选中的补丁 ID 添加到 plugins.CapacitorPatch.patches.
运行 npx capgo-capacitor-patch doctor --strict.
运行 npx cap sync.

当选中的补丁目标 @capacitor/cli,补丁将应用到安装的 CLI 包和下一个 cap 命令使用修补的 CLI code。

继续从 Getting Started

如果您正在使用 Getting Started 为了计划原生插件工作，连接它与使用 @capgo/capacitor-patch 对于原生能力在使用 @capgo/capacitor-patch 中 Capgo 原生插件目录对于产品工作流程在 Capgo 原生插件目录中 Capacitor 由 Capgo 的插件对于实现细节在 Capacitor 由 Capgo 的插件中添加或更新插件对于实现细节在添加或更新插件中， Ionic 企业插件替代品对于产品工作流程在 Ionic 企业插件替代品中