@byokit/pair weekly downloads statistics

<h1 align="center">@byokit/pair</h1> <p align="center"> <a href="https://www.npmjs.com/package/@byokit/pair"><img alt="npm" src="https://img.shields.io/npm/v/@byokit/pair?style=flat&label=npm" /></a> <a href="https://github.com/umeranjum17/byokit/actions/workflows/ci.yml"><img alt="CI" src="https://img.shields.io/github/actions/workflow/status/umeranjum17/byokit/ci.yml?style=flat&branch=main" /></a> <a href="LICENSE"><img alt="Apache 2.0" src="https://img.shields.io/badge/license-Apache--2.0-666?style=flat" /></a> <img alt="Node | browsers | React Native" src="https://img.shields.io/badge/platform-Node%20%7C%20browsers%20%7C%20React%20Native-666?style=flat" /> </p> <p align="center"><strong>Scan a code to pair a phone or browser with the home computer.</strong><br/> One encrypted link between the two. The computer (the <strong>host</strong>) keeps every credential; a device holds only its own key and a grant, and asks the host to do things. For apps that reach a person's own computer from their phone or browser.</p>

This package was published as @byokit/link up to 0.8.x. @byokit/link still re-exports it unchanged through 0.8.x and is removed in 0.9.0; new installs use @byokit/pair.

<p align="center"> <img src="https://raw.githubusercontent.com/umeranjum17/byokit/main/docs/images/herdr-kit-host.png" width="420" alt="A terminal running npm start -- --herdr &quot;$(command -v herdr)&quot; --via lan --name 'Kitchen computer', showing a large pairing QR code, then: On the phone, scan this, or open http://192.168.1.144:7310/ and type K3J8-CJZ7-SE4R. Codes last five minutes. Press Enter for new ones. Connecting to Herdr… Connected to Herdr. (stand-in Herdr)" /> <img src="https://raw.githubusercontent.com/umeranjum17/byokit/main/examples/herdr-kit/docs/2-compare.png" width="240" alt="A phone page titled Agents, under Pair this phone: Check your computer shows these two words, then say yes there. The words are coast comet." /> </p> <p align="center">_{Left: the host terminal of <a href="https://github.com/umeranjum17/byokit/tree/main/examples/herdr-kit">examples/herdr-kit</a> (<code>npm start -- --herdr "$(command -v herdr)" --via lan --name 'Kitchen computer'</code>, pictured against the kit's stand-in Herdr, <code>BYOKIT_EXAMPLE_FAKE=1</code>) showing the QR and the typed code. Right: the phone in the same example showing the two words to compare.}</p>

Noise IK over WebSocket (noise-handshake + libsodium; frames sealed by @noble/ciphers), in Node, browsers/PWAs and React Native. The main entry has no listener, files or environment access: the app hands the host its sockets and stores. Threat model and review checklist: SECURITY.md.

Host policy and streams are available; relay routing is in @byokit/relay.

Install

npm install @byokit/pair

· Latest release · All releases

Quickstart

npm install @byokit/pair ws

ws is only the WebSocket server for this example; any server works. A host and a device in one file, on loopback:

import { WebSocketServer } from 'ws';
import { DeviceLink, Host, keyPair, pairWithOffer } from '@byokit/pair';

// The computer: it keeps the credentials and answers requests.
const host = await Host.open({
  keys: keyPair(),                       // keep it with hostKeyFile() from '@byokit/pair/node' in a real app
  name: 'Kitchen computer',
  confirm: ({ name, words }) => { console.log(`host: pair ${name}? it shows "${words}"`); return true; },
  handle: (req, device) => ({ echo: req.args, from: device.name }),
});
const wss = new WebSocketServer({ host: '127.0.0.1', port: 7300 });
wss.on('connection', (ws) => host.accept(ws));

// The offer is what the QR code shows.
const { text } = host.compactOffer({ role: 'control', urls: ['ws://127.0.0.1:7300/link'] });

// The phone or browser: scan, compare the words, then ask.
const grant = await pairWithOffer(text, { name: 'Pixel 9', onWords: (w) => console.log(`device: check "${w}"`) });
const link = new DeviceLink(grant, { onStatus: (s) => console.log(`device: ${s}`) });
console.log('answer:', await link.request('say.hello', { text: 'hi' }));

link.stop(); host.close(); wss.close();

Output (the two words differ on every run):

device: check "rose oak"
host: pair Pixel 9? it shows "rose oak"
device: online
answer: { echo: { text: 'hi' }, from: 'Pixel 9' }

API at a glance…