开始使用

复制一个安装步骤和完整的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: shim 和直接 API 使用的主要 HTTPS 依赖方源
domains: 用于补充本地配置的额外依赖方主机名
autoShim: 默认值 true 并控制本地 cap sync 自动配置钩子

sync 为你提供的补丁

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

iOS：需要时会将域名关联和 Xcode 权限绑定
Android： asset_statements 元数据和生成的资源

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

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

平台指南

域名关联和

Android 配置 apple-app-site-association.

数字资产链接和

后端笔记 assetlinks.json.

iOS：需要时会将域名关联和 Xcode 权限绑定

源验证和 Android 陷阱。