Getting Started

新项目安装

您可以使用我们的 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.

如果您更喜欢手动设置，请运行以下命令安装包并遵循以下平台特定的说明：

1. 安装核心包

   npm install @capacitor-plus/core @capacitor-plus/cli

2. 添加平台包

   npm install @capacitor-plus/android  # for Android
   npm install @capacitor-plus/ios      # for iOS

3. 初始化Capacitor

   npm

   npx cap init

   pnpm

   pnpm cap init

   yarn

   yarn cap init

   bun

   bunx cap init

4. 添加平台

   npm

   npx cap add android

   pnpm

   pnpm cap add android

   yarn

   yarn cap add android

   bun

   bunx cap add android

   npm

   npx cap add ios

   pnpm

   pnpm cap add ios

   yarn

   yarn cap add ios

   bun

   bunx cap add ios

从官方Capacitor迁移

如果您有一个现有的Capacitor项目，迁移到Capacitor+是简单的：

1. 移除官方包

   npm uninstall @capacitor/core @capacitor/cli @capacitor/android @capacitor/ios

2. 安装Capacitor+包

   npm install @capacitor-plus/core @capacitor-plus/cli
   npm install @capacitor-plus/android  # if using Android
   npm install @capacitor-plus/ios      # if using iOS

3. 同步你的项目

   npm

   npx cap sync

   pnpm

   pnpm cap sync

   yarn

   yarn cap sync

   bun

   bunx cap sync

注意

无需任何code修改！Capacitor+与官方Capacitor具有相同的API。您的导入和code保持不变。

使用

由于 Capacitor+ 与 API-兼容，code 的现有功能无需更改：

import { Capacitor } from '@capacitor/core';
import { registerPlugin } from '@capacitor/core';

// Check platform
const platform = Capacitor.getPlatform();
console.log('Running on:', platform);

// Check if native
if (Capacitor.isNativePlatform()) {
  console.log('Running on native platform');
}

// Register a custom plugin
const MyPlugin = registerPlugin('MyPlugin');

使用官方 Capacitor 插件

所有官方 Capacitor 插件都可以无缝工作：

import { Camera, CameraResultType } from '@capacitor/camera';
import { Geolocation } from '@capacitor/geolocation';
import { Storage } from '@capacitor/preferences';

// Camera
const photo = await Camera.getPhoto({
  quality: 90,
  resultType: CameraResultType.Uri
});

// Geolocation
const position = await Geolocation.getCurrentPosition();

// Storage
await Storage.set({ key: 'name', value: 'John' });

使用 Capgo 插件

Capgo 插件与 Capacitor+ 完美兼容：

import { CapacitorUpdater } from '@capgo/capacitor-updater';
import { ScreenOrientation } from '@capgo/capacitor-screen-orientation';
import { CapacitorFlash } from '@capgo/capacitor-flash';

// Live updates
await CapacitorUpdater.notifyAppReady();

// Screen orientation
await ScreenOrientation.lock({ orientation: 'portrait' });

// Flashlight
await CapacitorFlash.toggle();

同步的工作原理

┌─────────────────────┐     ┌──────────────────┐     ┌──────────────────┐     ┌─────────────────┐
│  ionic-team/        │     │  CI/CD           │     │  Claude Code     │     │  npm publish    │
│  capacitor          │────▶│  Pipeline        │────▶│  Security Review │────▶│  @capacitor-plus│
│  (upstream)         │     │  (daily sync)    │     │  (AI analysis)   │     │  packages       │
└─────────────────────┘     └──────────────────┘     └──────────────────┘     └─────────────────┘

1. 每日同步: GitHub 动作从 ionic-team/capacitor
2. PR 创建: 更改作为 pull 请求提交到 plus 分支
3. CI 验证: 全套测试运行 (lint, 单元测试, iOS 构建, Android 构建)
4. 安全审查: AI 驱动的分析检查漏洞和破坏性更改
5. 自动合并: 只有 CI 通过 AND 安全审查通过
6. 自动发布: 在 npm 下发布的新版本 @capacitor-plus/*

安全审查详情

每次上游同步都会分析：

检查	它捕获了什么
安全	命令注入、XSS、路径遍历、硬编码密钥
破坏性更改	删除/重命名的 API、签名更改、配置更改
稳定性	空指针异常、未处理的异常、竞争条件、内存泄露
数据安全	数据丢失场景、隐私泄露、不安全的存储
Code完整性	混淆的code、可疑的网络调用、后门

注意

如果检测到任何问题，PR将被标记为手动审查，并不会自动合并。这确保了您始终可以获得稳定的、安全的版本。

提交您的PR

您的PR在官方Capacitor仓库中卡住了？在Capacitor+中获取它合并：

1. 开启一个问题 在 Capacitor+ 仓库 链接到您的上游 PR

2. 或直接提交 作为上游仓库的 PR plus 分支

3. 团队将审查、运行 CI，并在通过后合并

这样您和其他人可以立即从您的工作中受益，而不必等待上游发布周期

常见问题

这是否是生产环境可用的?

Yes. Capacitor+ 在生产应用中使用。每个发布都通过同一套测试套件（官方Capacitor）以及额外的安全分析通过。

我的官方插件还能正常工作吗？

是的。所有插件都可以直接使用__CAPGO_KEEP_0__+。 @capacitor/* plugins work with Capacitor+ out of the box.

关于如果上游发布了一个破坏性更新会怎么样？

如何报告问题？

关于如何报告问题？

__CAPGO_KEEP_0__+ __CAPGO_KEEP_1__仓库 Capacitor+ GitHub. 对于影响官方 Capacitor 的问题，我们将协助上游处理。

我想贡献?

当然！PR 都欢迎。您可以直接提交修复或要求合并特定的上游 PR。

继续从 Getting Started

如果您正在使用 Getting Started 来规划原生插件工作，连接它与 使用 Capacitor+ (@capacitor-plus) 包 用于在使用 Capacitor+ (@capacitor-plus) 包中 原生能力的 Capgo 插件目录 在Capgo插件目录中， Capacitor插件由Capgo提供， 在Capacitor插件由Capgo中， 添加或更新插件 在添加或更新插件中， Ionic企业插件替代方案 在Ionic企业插件替代方案中，