{
"repo": "hypershell",
"timestamp": "2026-01-16T23:39:33.006Z",
"entryPoint": "index.js",
"exports": {
"packageJson": {
"main": "index.js"
}
},
"api": {},
"readme": {
"content": "# hypershell\n\nSpawn shells anywhere. Fully peer-to-peer, authenticated, and end to end encrypted.\n\n## Install\n```\nnpm i -g hypershell\n```\n\n## Usage\n```shell\n# Create keys\nhypershell-keygen [-f keyfile] [-c comment]\n\n# Create a P2P server\nhypershell-server [-f keyfile] [--firewall filename] [--disable-firewall] [--protocol name]\n\n# Connect to a P2P shell\nhypershell <server key or name> [-f keyfile]\n\n# Local tunnel that forwards to remote host\nhypershell <server key or name> -L [address:]port:host:hostport\n\n# Copy files (download and upload)\nhypershell-copy <[@host:]source> <[@host:]target> [-f keyfile]\n```\n\nUse `--help` with any command for more information, for example `hypershell-server --help`.\n\n## First steps\nKeys are automatically created with a default filename on first run.\n\nOtherwise, you can first do:\n```bash\nhypershell-keygen\n```\n\nJust connect to servers (they have to allow your public key):\n```bash\nhypershell <server name or public key>\n```\n\nYou could also create a server:\n``",
"sections": [
"intro",
"install",
"usage",
"first steps",
"known peers",
"hypershell-copy",
"local tunnel",
"multiple keys",
"restrict server protocols",
"license"
],
"hasApi": true,
"hasExamples": true,
"exampleCount": 14,
"examples": [
"npm i -g hypershell",
"Use `--help` with any command for more information, for example `hypershell-server --help`.\n\n## First steps\nKeys are automatically created with a default filename on first run.\n\nOtherwise, you can first do:",
"Just connect to servers (they have to allow your public key):"
]
},
"patterns": [
"dht-discovery",
"stream-multiplexing",
"binary-encoding"
]
}