开始
复制一个包含安装步骤和本插件的完整 Markdown 指南的配置提示。
Set up this Capacitor plugin in the project.
Use the package manager already used by the project.
Install these packages:
- `@capacitor-plus/core`
- `@capacitor-plus/cli`
- `@capacitor-plus/android` if the project targets Android
- `@capacitor-plus/ios` if the project targets iOS
Complete the required Capacitor initialization, platform, sync, native setup, and configuration work.
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-plus/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 助手设置来安装 Capacitor+。使用以下命令将 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 `@capacitor-plus/core`, `@capacitor-plus/cli`, `@capacitor-plus/android`, and `@capacitor-plus/ios` packages in my project.如果您更喜欢手动设置,请运行以下命令安装包并遵循以下平台特定的说明:
-
安装核心包
终端窗口 npm install @capacitor-plus/core @capacitor-plus/cli -
添加平台包
终端窗口 npm install @capacitor-plus/android # for Androidnpm install @capacitor-plus/ios # for iOS -
初始化 Capacitor
终端窗口 npx cap init终端窗口 pnpm cap init终端窗口 yarn cap init终端窗口 bunx cap init -
添加平台
终端窗口 npx cap add android终端窗口 pnpm cap add android终端窗口 yarn cap add android终端窗口 bunx cap add android终端窗口 npx cap add ios终端窗口 pnpm cap add ios终端窗口 yarn cap add ios终端窗口 bunx cap add ios
从官方Capacitor迁移
从官方Capacitor迁移如果您有一个现有的Capacitor项目,迁移到Capacitor+是简单的:
-
移除官方包
终端窗口 npm uninstall @capacitor/core @capacitor/cli @capacitor/android @capacitor/ios -
安装 Capacitor+ 包
终端窗口 npm install @capacitor-plus/core @capacitor-plus/clinpm install @capacitor-plus/android # if using Androidnpm install @capacitor-plus/ios # if using iOS -
同步你的项目
终端窗口 npx cap sync终端窗口 pnpm cap sync终端窗口 yarn cap sync终端窗口 bunx cap sync
使用
使用由于Capacitor+与API-兼容,code的现有功能无需修改:
import { Capacitor } from '@capacitor/core';import { registerPlugin } from '@capacitor/core';
// Check platformconst platform = Capacitor.getPlatform();console.log('Running on:', platform);
// Check if nativeif (Capacitor.isNativePlatform()) { console.log('Running on native platform');}
// Register a custom pluginconst MyPlugin = registerPlugin('MyPlugin');使用官方Capacitor插件
标题:使用官方Capacitor插件所有官方Capacitor插件都可以无缝工作:
import { Camera, CameraResultType } from '@capacitor/camera';import { Geolocation } from '@capacitor/geolocation';import { Storage } from '@capacitor/preferences';
// Cameraconst photo = await Camera.getPhoto({ quality: 90, resultType: CameraResultType.Uri});
// Geolocationconst position = await Geolocation.getCurrentPosition();
// Storageawait Storage.set({ key: 'name', value: 'John' });使用Capgo插件
标题:使用Capgo插件Capgo插件与Capacitor+完全兼容:
import { CapacitorUpdater } from '@capgo/capacitor-updater';import { ScreenOrientation } from '@capgo/capacitor-screen-orientation';import { CapacitorFlash } from '@capgo/capacitor-flash';
// Live updatesawait CapacitorUpdater.notifyAppReady();
// Screen orientationawait ScreenOrientation.lock({ orientation: 'portrait' });
// Flashlightawait CapacitorFlash.toggle();同步的工作原理
标题:同步的工作原理┌─────────────────────┐ ┌──────────────────┐ ┌──────────────────┐ ┌─────────────────┐│ ionic-team/ │ │ CI/CD │ │ Claude Code │ │ npm publish ││ capacitor │────▶│ Pipeline │────▶│ Security Review │────▶│ @capacitor-plus││ (upstream) │ │ (daily sync) │ │ (AI analysis) │ │ packages │└─────────────────────┘ └──────────────────┘ └──────────────────┘ └─────────────────┘- 每日同步: GitHub 从
ionic-team/capacitor - PR 创建: 将更改提议为拉取请求到
plus分支 - CI 验证: 全套测试运行 (lint, 单元测试, iOS 构建, Android 构建)
- 安全审查: AI 驱动分析检查漏洞和破坏性更改
- 自动合并: 只有 CI 通过 AND 安全审查通过
- 自动发布: npm 下发布的新版本
@capacitor-plus/*
安全审查详情
标题为“安全审查详情”的部分每次上游同步都会分析:
| 检查 | 它捕获了什么 |
|---|---|
| 安全 | 命令注入、XSS、路径遍历、硬编码密钥 |
| 重大变更 | 删除/重命名的 API、签名改变、配置变更 |
| 稳定性 | 空指针异常、未处理的异常、竞争条件、内存泄露 |
| 数据安全 | __CAPGO_KEEP_0__完整性 |
| 混淆的Code、可疑的网络调用、后门 | Obfuscated code, suspicious network calls, backdoors |
Have a PR stuck in the official Capacitor repo? Get it merged in Capacitor+:
-
打开一个问题 在 Capacitor+仓库 连接到您的上游PR
-
或直接提交 作为上游仓库的
plusbranch -
团队会审查、运行CI,并合并如果通过
这样您和其他人可以立即从您的工作中受益而不必等待上游发布周期
常见问题
标题为“常见问题”是否是生产环境可用?
标题为“是否是生产环境可用?”是的。Capacitor+ 在生产应用中使用。每个版本都通过相同的测试套件通过,包括官方Capacitor,并进行了额外的安全分析。
我的官方插件还能正常工作吗?
关于官方插件是否还能正常工作的问题是的。所有 @capacitor/* 插件都可以直接使用Capacitor+。
如果上游发布了一个破坏性更新?
关于上游发布破坏性更新的问题人工审核工具会标记破坏性更新。您将在更新被合并之前看到这些更新的文档。
如何报告问题?
关于如何报告问题的问题在 Capacitor+ GitHub. 对于影响官方 Capacitor 的问题,我们将协助上游处理。
我可以贡献吗?
标题:我可以贡献吗?当然!PR 都欢迎。您可以直接提交修复或要求合并特定的上游 PR。
继续从 Getting Started
标题:继续从 Getting Started如果您正在使用 Getting Started 来规划原生插件工作,连接它与 使用 Capacitor+ (@capacitor-plus) Packages for the native capability in Using Capacitor+ (@capacitor-plus) Packages, 使用 Capgo+ (@__CAPGO_KEEP_1__-plus) Packages 中的原生能力, 为产品工作流程在 Capgo 插件目录中, Capacitor 插件由 Capgo 为实现细节在 Capacitor 插件由 Capgo 中, 添加或更新插件 为实现细节在添加或更新插件,和 Ionic 企业插件替代方案 为产品工作流程在 Ionic 企业插件替代方案中。