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

Migrating from Official Capacitor

If you have an existing Capacitor project, migrating to Capacitor+ is simple:

1. 移除官方包

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

2. Install Capacitor+ packages

   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保持不变。

使用

Since Capacitor+ is API-compatible, your existing code works without changes:

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');

With Official Capacitor Plugins

All official Capacitor plugins work seamlessly:

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' });

With Capgo Plugins

Capgo plugins work perfectly with 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();

Sync 的工作原理

┌─────────────────────┐     ┌──────────────────┐     ┌──────────────────┐     ┌─────────────────┐
│  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 branch
3. CI 验证: 运行完整测试套件 (lint, 单元测试, iOS 构建, Android 构建)
4. 安全审查: AI 驱动的分析检查漏洞和破坏性更改
5. 自动合并: 只有 CI 通过 AND 安全审查通过
6. 自动发布: 新版本发布到 npm 下 @capacitor-plus/*

安全审查细节

每次上游同步都会分析:

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

注意

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

提交您的PR

在官方Capacitor仓库中有一个 PR 卡住了？让我们在Capacitor+中合并它：

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

2. 或者直接提交 作为 plus branch

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

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

常见问题

是否该用于生产环境?

是。Capacitor+ 已在生产应用中使用。每次发布都经过同一测试套件的测试，包括官方Capacitor，并进行了额外的安全分析。

我的官方插件是否仍然有效?

是。所有 @capacitor/* 插件都可以直接使用Capacitor+。

如果上游发布了一个破坏性更新?

人工安全审查会标记破坏性更新进行手动审查。您将在合并之前看到这些更新的文档。

如何报告问题?

在文件中报告问题 Capacitor+ GitHub 仓库对于影响官方 Capacitor 的问题，我们将协调上游。

我可以贡献吗？

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

继续从 Getting Started

如果您正在使用 Getting Started 来规划原生插件工作，连接它与 使用 Capacitor+ (@capacitor-plus) 包 为使用 Capacitor+ (@capacitor-plus) 包的本地能力 Capgo 插件目录 为 Capgo 插件目录中的产品工作流 Capacitor 由 Capgo 提供的插件 为 Capacitor 由 Capgo 提供的插件中的实现细节 添加或更新插件 为添加或更新插件中的实现细节, 和 Ionic 企业插件替代品 为 Ionic 企业插件替代品中的产品工作流