开始使用

安装

您可以使用我们的AI辅助设置来安装插件。使用以下命令将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 `@capgo/capacitor-passkey` plugin in my project.

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

1. 安装包

   bun add @capgo/capacitor-passkey

2. 同步本机项目

   bunx cap sync

3. 添加插件配置

   import type { CapacitorConfig } from '@capacitor/cli';
   
   const config: CapacitorConfig = {
     appId: 'app.capgo.passkey.example',
     appName: 'My App',
     webDir: 'dist',
     plugins: {
       CapacitorPasskey: {
         origin: 'https://signin.example.com',
         autoShim: true,
         domains: ['signin.example.com'],
       },
     },
   };
   
   export default config;

4. 在引导期间安装 shim

   import { CapacitorPasskey } from '@capgo/capacitor-passkey';
   
   await CapacitorPasskey.autoShimWebAuthn();

5. 保持正常的 WebAuthn 流程

   const registration = await navigator.credentials.create({
     publicKey: registrationOptions,
   });
   
   const authentication = await navigator.credentials.get({
     publicKey: requestOptions,
   });

插件配置的作用

配置从 plugins.CapacitorPasskey 在 capacitor.config.*.

• origin: 主要 HTTPS 依赖方源用于 shim 和直接 API
• domains: 需要在本地配置同步期间补充的额外依赖方主机名
• autoShim: 默认值为 true 和控制本地 cap sync 自动配置钩子

What sync patches for you

当您运行 bunx cap sync, 插件会更新生成的本机主机项目：

• iOS：当需要时，关联域名权限和 Xcode 权限
• Android： asset_statements 元数据和由清单使用的生成资源

hook不会为您发布网站的信任文件。您仍然需要托管：

• https://your-domain/.well-known/apple-app-site-association
• https://your-domain/.well-known/assetlinks.json

平台指南

iOS设置

关联域名和 apple-app-site-association.

Android设置

数字资产链接和 assetlinks.json.

后端笔记

起源验证和Android注意事项。

__CAPGO_KEEP_0__

如果您正在使用 开始使用 为了计划身份验证和帐户流程，连接它与 使用@capgo/capacitor-passkey 为native能力在使用@capgo/capacitor-passkey, @capgo/capacitor-social-login 为实现细节在@capgo/capacitor-social-login, @capgo/capacitor-passkey 为实现细节在@capgo/capacitor-passkey, @capgo/capacitor-native-biometric 为实现细节在@capgo/capacitor-native-biometric, 和 双因素身份验证 为实现细节在双因素身份验证.