# passkify

> Passkeys (WebAuthn) for a website: client and server in one npm package, zero
> runtime dependencies, and every check the WebAuthn specification asks for.
> Runs on Node 20+, Bun, Deno, Cloudflare Workers and Vercel Edge.
> Version 0.2.0. MIT licensed.

Install with `npm install passkify`. Import `passkify/server` on the server and
`passkify/client` in the browser — the package root is server code and will fail
to build in a browser bundle.

## Getting started

- [Introduction](https://passkify.himanshubuilds.in/docs.md): What passkify does, what it deliberately does not do, and how the pieces fit.
- [Installation](https://passkify.himanshubuilds.in/docs/installation.md): Install the package, pick your entry points, and check runtime requirements.
- [Quickstart](https://passkify.himanshubuilds.in/docs/quickstart.md): A working passwordless sign-up and sign-in, end to end, in about five minutes.
- [How passkeys work](https://passkify.himanshubuilds.in/docs/how-passkeys-work.md): Relying Party ID, challenges, user handles, discoverable credentials.
- [Examples](https://passkify.himanshubuilds.in/docs/examples.md): Complete runnable apps for Express and Next.js, with every file listed.

## Server

- [PasskeyServer](https://passkify.himanshubuilds.in/docs/server/passkey-server.md): The one object you construct, and every method it exposes.
- [Configuration](https://passkify.himanshubuilds.in/docs/server/configuration.md): Every option on PasskeyServerConfig, what it changes, and when to move it.
- [Registration](https://passkify.himanshubuilds.in/docs/server/registration.md): startRegistration and finishRegistration, and the eighteen checks in between.
- [Authentication](https://passkify.himanshubuilds.in/docs/server/authentication.md): startAuthentication and finishAuthentication, usernameless and username-first.
- [Credential management](https://passkify.himanshubuilds.in/docs/server/credentials.md): Listing, renaming and revoking passkeys from an account settings page.
- [HTTP adapters](https://passkify.himanshubuilds.in/docs/server/adapters.md): The Express middleware, the fetch handler, and the routes they mount.

## Browser

- [Client API](https://passkify.himanshubuilds.in/docs/client.md): register, login, autofill, capability detection, and the low-level ceremony calls.

## Storage

- [PasskeyStore](https://passkify.himanshubuilds.in/docs/storage.md): The ten-method persistence contract and the three rules that matter.
- [Store adapters](https://passkify.himanshubuilds.in/docs/storage/adapters.md): Working implementations for Postgres, Prisma, Drizzle, Redis and MongoDB.

## Reference

- [Errors](https://passkify.himanshubuilds.in/docs/errors.md): Every PasskeyError code, what causes it, and what to do about it.
- [Types](https://passkify.himanshubuilds.in/docs/types.md): Every exported interface and type alias.
- [Low-level primitives](https://passkify.himanshubuilds.in/docs/low-level.md): CBOR, COSE keys, authenticator data. For tooling, not for websites.

## Guides

- [Frameworks](https://passkify.himanshubuilds.in/docs/guides/frameworks.md): Express, Next.js, Hono, SvelteKit, Remix, Bun, Deno, Cloudflare Workers.
- [Adding to an existing app](https://passkify.himanshubuilds.in/docs/guides/existing-app.md): Staged rollout alongside passwords, without opening an account-takeover hole.
- [Security model](https://passkify.himanshubuilds.in/docs/guides/security.md): The full verification checklist, design decisions, and what stays your job.
- [Troubleshooting](https://passkify.himanshubuilds.in/docs/guides/troubleshooting.md): NotAllowedError, origin_mismatch, challenge_not_found, testing on a phone.

## Resources

- [FAQ](https://passkify.himanshubuilds.in/docs/faq.md): Short answers to the questions that come up before and during adoption.
- [Changelog](https://passkify.himanshubuilds.in/docs/changelog.md): Release history, and the compatibility promise for each part of the API.

## For coding agents

- [Everything, as one file](https://passkify.himanshubuilds.in/llms-full.txt): the complete documentation
- Skills for your agent: `npx passkify skills install` — installs five skills covering the server, the browser, storage and debugging
- MCP server: `npx passkify mcp` — search the docs, explain an error code, or validate a configuration against the real validator
- Check an integration: `npx passkify doctor`

## Optional

- [Source](https://github.com/AbnormalPilot/passkify)
- [npm](https://www.npmjs.com/package/passkify)