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.
新プロジェクトのインストール
「新プロジェクトのインストール」のセクション-
コア パッケージをインストールします
ターミナル画面 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”If you have an existing Capacitor project, migrating to Capacitor+ is simple:
-
公式から移行する
公式の __CAPGO_KEEP_0__ プロジェクトがあれば、 __CAPGO_KEEP_1__+ への移行は簡単です:「公式から移行する」を参照してください。 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();Syncのしくみ
「Syncのしくみ」タイトルのセクション┌─────────────────────┐ ┌──────────────────┐ ┌──────────────────┐ ┌─────────────────┐│ ionic-team/ │ │ CI/CD │ │ Claude Code │ │ npm publish ││ capacitor │────▶│ Pipeline │────▶│ Security Review │────▶│ @capacitor-plus││ (upstream) │ │ (daily sync) │ │ (AI analysis) │ │ packages │└─────────────────────┘ └──────────────────┘ └──────────────────┘ └─────────────────┘- 毎日Sync: GitHub アクションで最新の変更を取得します。
ionic-team/capacitor - PR 作成: プルリクエストとして変更が提案されます。
plusブランチ - CI 検証: 全テストスイートが実行されます (lint、ユニットテスト、iOS ビルド、Android ビルド)
- セキュリティレビュー: AI が脆弱性や破壊的な変更を検出する分析が実行されます。
- 自動マージ: CI が通過し、セキュリティレビューが承認した場合のみ
- 自動公開: 新しいバージョンが npm に公開されます。
@capacitor-plus/*
セキュリティ レビュー詳細
セキュリティ レビュー詳細のセクションすべてのアップストリームの同期は、以下の内容を分析します。
| チェック | 検出されるもの |
|---|---|
| セキュリティ | コマンドインジェクション、XSS、パス トラバーサル、ハードコードされたシークレット |
| 変更点 | 削除または名前が変更されたAPI、サインチャが変更された、構成の変更 |
| 安定性 | Null ポインタの参照、未処理の例外、レース条件、メモリリーク |
| データの安全性 | データ喪失シナリオ、プライバシー侵害、不正確なストレージ |
| Code の完全性 | code が隠蔽され、疑わしいネットワークコール、バックドア |
PRを提出する
「PRを提出する」のセクションCapacitor+ リポジトリにPRが詰まっている場合、Capacitor+:でマージしてください。
-
問題を報告する 「 Capacitor+ リポジトリ アップストリームのPRにリンクする
-
Or 直接提出する アップストリームの
plusブランチ -
チームはレビュー、CIを実行し、通過した場合にマージする
この方法で、すぐにアップストリームのリリースサイクルを待たずに、自分の作業から利益を得られる
FAQ
「FAQ」このプロダクション用?
「このプロダクション用?」はい。Capacitor+は実際のプロダクションアプリで使用されています。すべてのリリースは公式のCapacitorと同じテストスイートを通過し、さらにセキュリティ分析を実行します。
私の公式プラグインはまだ動作するでしょうか?
「公式プラグインはまだ動くでしょうか?」という質問のセクションはい、すべての @capacitor/* Capacitor+のプラグインは、箱の中から動作します。
アップストリームが破壊的な変更をリリースした場合に何が起こるでしょうか?
「アップストリームが破壊的な変更をリリースした場合に何が起こるでしょうか?」という質問のセクションAI セキュリティ レビューは破壊的な変更を手動でレビューするためにフラグを立てます。変更はマージされる前にドキュメント化されます。
問題を報告するにはどのようにすればいいですか?
「問題を報告するにはどのようにすればいいですか?」という質問のセクション__CAPGO_KEEP_0__+ __CAPGO_KEEP_1__ リポジトリに Capacitor+ GitHub repo. For issues that also affect official Capacitor, we’ll help coordinate upstream.
Can I contribute?
「コントリビュートすることは可能ですか?」というセクションぜひ!PRは歓迎します。直接修正を提出するか、特定のアップストリームPRをマージするよう求めることができます。
「Getting Started」から続けて
「Getting Started」から続けてあなたが「 「Getting Started」を使用して ネイティブ プラグインの作業を計画する場合、 Using Capacitor+ (@capacitor-plus) Packages for the native capability in Using Capacitor+ (@capacitor-plus) Packages, Capgo Plugin Directory for the product workflow in Capgo Plugin Directory, Capacitor Plugins by Capgo 実装詳細については Capacitor プラグインの Capgo を参照してください。 プラグインの追加または更新 実装詳細についてはプラグインの追加または更新、 Ionic Enterprise プラグインの代替 Ionic Enterprise プラグインの代替の製品ワークフローについては