Getting Started

复制一个设置提示，包含安装步骤和该插件的完整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.

安装

npm install @capgo/capacitor-patch
npx cap sync

直到您在Capacitor配置中选择补丁包，包裹都是无效的。

选择补丁 ID

列出所有已发货补丁：

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 继续

如果您正在使用 开始使用 为了native插件工作的规划，连接它与使用@capgo/capacitor-patch 对于native能力的使用在使用@capgo/capacitor-patch, Capgo native插件目录对于产品工作流程在Capgo native插件目录, Capacitor native插件由Capgo 对于实现细节在Capacitor native插件由Capgo, 添加或更新native插件对于实现细节在添加或更新native插件,和 Ionic企业级插件替代方案对于产品工作流程在Ionic企业级插件替代方案.