Getting Started
このプラグインのインストール手順とフルマークダウンガイドをコピーします。
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.
新プロジェクトのインストール
セクション「新プロジェクトのインストール」You can use our AI-Assisted Setup to install Capacitor+. Add the Capgo skills to your AI tool using the following command:
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.Manual Setup を使用する場合は、以下のコマンドを実行してください。プラットフォーム固有の指示に従ってください。
-
コアパッケージのインストール
ターミナルウィンドウ npm install @capacitor-plus/core @capacitor-plus/cli -
プラットフォームパッケージの追加
ターミナルウィンドウ npm install @capacitor-plus/android # for Androidnpm install @capacitor-plus/ios # for iOS -
Initialize 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__CAPGO_KEEP_0__ 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”If you have an existing Capacitor project, migrating to Capacitor+ is simple:
-
公式のパッケージを削除する
ターミナル画面 npm uninstall @capacitor/core @capacitor/cli @capacitor/android @capacitor/ios -
Install Capacitor+ packages
ターミナル画面 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();Syncのしくみ
Syncのしくみ┌─────────────────────┐ ┌──────────────────┐ ┌──────────────────┐ ┌─────────────────┐│ ionic-team/ │ │ CI/CD │ │ Claude Code │ │ npm publish ││ capacitor │────▶│ Pipeline │────▶│ Security Review │────▶│ @capacitor-plus││ (upstream) │ │ (daily sync) │ │ (AI analysis) │ │ packages │└─────────────────────┘ └──────────────────┘ └──────────────────┘ └─────────────────┘- 毎日Sync: GitHub Actions 最新の変更を取得する
ionic-team/capacitor - PR作成: __CAPGO_KEEP_0__ に変更を提案する
plusbranch - CI検証: 全テストスイートを実行 (lint, unit tests, iOSビルド, Androidビルド)
- セキュリティレビュー: AIパワーで脆弱性や破壊的な変更を検出する
- 自動マージ: CI が通過し、セキュリティレビューが承認した場合のみ
- 自動公開: 新しいバージョンが npm 以下に公開される
@capacitor-plus/*
セキュリティレビューの詳細
セクションのタイトルは “セキュリティレビューの詳細”アップストリームの各 Sync は次の要素を分析します:
| チェック | 検知対象 |
|---|---|
| セキュリティ | コマンドインジェクション、XSS、パス トラバーサル、ハードコードされたシークレット |
| 変更点 | APIの削除/変更、サインチャーの変更、構成の変更 |
| 安定性 | Nullポインタの参照、未処理の例外、レース条件、メモリリーク |
| データの安全性 | データの喪失シナリオ、プライバシー侵害、不正なストレージ |
| Codeの完全性 | codeのオブフュージング、疑わしいネットワークコール、バックドア |
プルリクエストの提出
プルリクエストの提出公式のCapacitorリポジトリにPRが詰まっている場合、Capacitor+でマージしてください:
-
問題を開く 公式の Capacitor+リポジトリ アップストリームのPRへのリンク
-
または直接提出 ブランチ
plusチームはレビュー、CIを実行し、通過した場合にマージします -
このようにして、すぐにアップストリームのリリースサイクルを待たずに、自分の作業から他のユーザーも利益を得ることができます。
FAQ
公式の__CAPGO_KEEP_0__リポジトリにPRが詰まっている場合、__CAPGO_KEEP_1__+でマージしてください:
セクションのタイトル「FAQ」この製品は、実用的な環境で使用できますか?
「この製品は、実用的な環境で使用できますか?」Yes. Capacitor+ is used in production apps. Every release passes the same test suite as official Capacitor, plus additional security analysis.
公式のプラグインは正常に動作しますか?
「公式のプラグインは正常に動作しますか?」はい。すべてのプラグインはCapgo+と組み合わせて使用できます。 @capacitor/* plugins work with Capacitor+ out of the box.
「アップストリームから破壊的な変更がリリースされた場合にどうすればよいですか?」
セキュリティレビューのAIは、破壊的な変更を手動でレビューします。変更はマージされる前にドキュメント化されます。問題を報告するにはどうすればよいですか?
「問題を報告するにはどうすればよいですか?」
__CAPGO_KEEP_0__+は実用的なアプリケーションで使用されています。__CAPGO_KEEP_1__は公式のCapacitorです。問題はCloudflareの Capacitor + GitHubCapacitor + __CAPGO_KEEP_1__
公式の__CAPGO_KEEP_0__にも影響を与える場合は、上流の調整を支援します。
Capacitor Plusに貢献することはできますか?「Capacitor Plusに貢献することはできますか?」
もちろんです! PRは歓迎されています。直接修正を提出するか、特定の上流のPRをマージするよう要求することができます。
Capacitor PlusのGetting Startedから続けてください。「Capacitor PlusのGetting Startedから続けてください。」 Capacitor Plusを使用して Capacitor PlusのGetting Started Using Capacitor+ (@capacitor-plus) Packages for the native capability in Using Capacitor+ (@capacitor-plus) Packages, Capgo プラグイン ディレクトリ for the product workflow in Capgo Plugin Directory, Capacitor Plugins by Capgo for the implementation detail in Capacitor Plugins by Capgo, プラグインの追加または更新 プラグインの追加または更新の実装詳細、 Ionic Enterprise プラグインの代替 Ionic Enterprise プラグインの代替の製品ワークフロー