开始使用

复制一个包含安装步骤和此插件的完整 Markdown 指南的配置提示。

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-passkey`
Run the required Capacitor sync/update step after installation.
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/passkey/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.

安装包
终端窗口
```
bun add @capgo/capacitor-passkey
```
同步本地项目
终端窗口
```
bunx cap sync
```

添加插件配置

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;

在引导期间安装 shim

import { CapacitorPasskey } from '@capgo/capacitor-passkey';

await CapacitorPasskey.autoShimWebAuthn();

保持正常的 WebAuthn 流程

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

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

插件配置的作用

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

origin: primary HTTPS relying-party origin used by the shim and direct API
domains: 需要在本地配置中同步的额外依赖方主机名
autoShim: defaults to true 并控制原生 cap sync 自动配置钩子

What sync patches for you

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

iOS：域关联特权和Xcode特权绑定
Android： asset_statements 元数据和生成的资源

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

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

平台指南

iOS设置

__CAPGO_KEEP_0__ apple-app-site-association.

Android设置

__CAPGO_KEEP_0__ assetlinks.json.

后端说明

起源验证和Android注意事项