开始
复制一个包含安装步骤和本插件的完整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-pluginscontext
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
Migrating from Official Capacitor
Section titled “Migrating from Official 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
使用
Usage由于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 创建: 更改作为 pull 请求提交到
plusbranch - CI 验证: 全套测试(lint、单元测试、iOS 构建、Android 构建)
- 安全审查: AI 驱动分析检查漏洞和破坏性更改
- 自动合并仅当CI通过并且安全审查通过时
- Auto-Publish新版本已发布到npm下
@capacitor-plus/*
安全审计细节
安全审计细节每次上游同步都会分析以下内容:
| Check | 什么它捕获的 |
|---|---|
| 安全 | context: 企业产品/价格页面。角色:UI标签。见于:企业页面。消息键 `enterprise_hero_security_label` (企业英雄安全标签)。 |
| 命令注入、XSS、路径遍历、硬编码密钥 | Breaking Changes 中的更改: |
| 稳定性 | 空指针异常、未处理的异常、竞争条件、内存泄露 |
| 数据安全 | 数据丢失场景、隐私泄露、不安全的存储 |
| Code完整性 | 混淆的code、可疑的网络调用、后门 |
提交您的PR
提交您的PR有一个PR卡在官方Capacitor仓库中?在Capacitor+中获取它合并:
-
打开一个问题 在 Capacitor+ 仓库 链接到您的上游 PR
-
或直接提交 作为
plusbranch -
团队会审查、运行 CI,并合并如果它通过
这样您和其他人可以立即从您的工作中受益,而不必等待上游发布周期
标题:常见问题“”
Section titled “是否该用于生产环境?”是。Capacitor+ 已在生产应用中使用。每次发布都通过同一测试套件(官方Capacitor的测试套件)及额外的安全分析进行验证。
我的官方插件是否仍然有效?
Section titled “我的官方插件是否仍然有效?”是。所有 @capacitor/* 插件均支持Capacitor+ 的使用。
如果上游发布了破坏性更新?
Section titled “如果上游发布了破坏性更新?”人工安全审查会标记破坏性更新进行手动审查。您将在合并之前看到这些更新的文档。
如何报告问题?
Section titled “如何报告问题?”在 Capacitor+ GitHub 仓库. 对于影响官方 Capacitor 的问题,我们将协调上游。
我可以贡献吗?
标题:我可以贡献吗?当然!PR 都欢迎。您可以直接提交修复或要求合并特定上游 PR。
继续从 Getting Started
标题:继续从 Getting Started如果您正在使用 开始使用 来规划原生插件工作,连接它与 使用 Capacitor+ (@capacitor-plus) 包 来实现原生能力的 Using Capacitor+ (@capacitor-plus) 包 Capgo 插件目录 为产品工作流程在 Capgo 插件目录中 Capacitor 由 Capgo 提供的插件 为实现细节在 Capacitor 由 Capgo 提供的插件中 添加或更新插件 为实现细节在添加或更新插件中,并且 Ionic 企业插件替代品 为产品工作流程在 Ionic 企业插件替代品中