{
"repo": "hyperbeam",
"timestamp": "2026-01-16T23:39:31.544Z",
"entryPoint": "index.js",
"exports": {
"packageJson": {
"main": "index.js"
}
},
"api": {
"file": "index.js",
"exports": [
{
"type": "default",
"name": "class"
}
],
"classes": [
{
"name": "Hyperbeam"
}
],
"functions": [
{
"name": "toBase32"
},
{
"name": "fromBase32"
},
{
"name": "randomBytes"
}
]
},
"readme": {
"content": "# hyperbeam\n\nA 1-1 end-to-end encrypted internet pipe powered by [Hyperswarm](https://github.com/holepunchto/hyperswarm) and Noise\n\n```\nnpm install hyperbeam\n```\n\n## Usage\n\n``` js\nconst Hyperbeam = require('hyperbeam')\n\n// 'neznr3z3j44l7q7sgynbzpdrdlpausurbpcmqvwupmuoidolbopa' is 32-byte unique passphrase\n// to find the other side of your pipe.\n// once the other peer is discovered it is used to derive a noise keypair as well.\nconst beam = new Hyperbeam('neznr3z3j44l7q7sgynbzpdrdlpausurbpcmqvwupmuoidolbopa')\n\n// to generate a passphrase, leave the constructor empty and hyperbeam will generate one for you\n// const beam = new Hyperbeam()\n// beam.key // <-- your passphrase\n\n// make a little chat app\nprocess.stdin.pipe(beam).pipe(process.stdout)\n```\n\n## CLI\n\nPart of the [Hyperspace CLI, hyp](https://github.com/hypercore-protocol/cli)\n\nProvided here as a standalone CLI as well.\n\nFirst install it\n\n```sh\nnpm install -g hyperbeam\n```\n\nThen on one machine run\n\n```sh\necho 'hello world' | hyperbea",
"sections": [
"intro",
"usage",
"cli",
"api",
"license"
],
"hasApi": true,
"hasExamples": true,
"exampleCount": 4,
"examples": [
"npm install hyperbeam",
"## CLI\n\nPart of the [Hyperspace CLI, hyp](https://github.com/hypercore-protocol/cli)\n\nProvided here as a standalone CLI as well.\n\nFirst install it",
"Then on one machine run"
]
},
"patterns": [
"append-only-log",
"peer-discovery",
"dht-discovery",
"cryptography",
"streaming"
]
}