OverviewFilesCommitsIssuesDocsReleasesPeers

holepunchto-kb / skills / hyperssh / api-extract.json

33 lines · json ref:
{
  "repo": "hyperssh",
  "timestamp": "2026-01-16T23:39:34.223Z",
  "entryPoint": "index.js",
  "exports": {
    "packageJson": {
      "main": "index.js"
    }
  },
  "api": {},
  "readme": {
    "content": "# hyperssh\n\nSSH and SSHFS over the [Hyperswarm DHT](https://github.com/holepunchto/hyperdht)!\n\n## Installation\n```\nnpm install -g hyperssh // ssh / fuse client stubs\nnpm install -g hypertele // hyperswarm server proxy\nnpm install -g hyper-cmd-utils // keygen utils\n```\n\n## Usage\n\n### Server\n\nOn a server\n\n```sh\nhyper-cmd-util-keygen --gen_seed\n-> SEED\n\nhypertele-server --seed SEED -l 22\n-> PEER_KEY\n```\n\nThis will start announcing the server on the DHT.\n\n### Client\n\nOn the client\n\n```sh\nhyperssh -s ab01f... -u maf\nhyperssh -s ab01f... -u maf -i keypair.json\n```\n\nRead more about using identities here: https://github.com/prdn/hyper-cmd-docs/blob/main/identity.md\n\nSSHFS (mount a remove fs/folder via ssh)\n\n```sh\nhyperssh-fuse -s ab01f... -u maf -m ~/mnt\n```\n\nHyperswarm will do UDP holepunching under the hood, so even if your server is located on a home network it should be accessible.\n\n### Windows RDP\n\nYou can also use hyperssh with Windows RDP to remotely log in to your windows machines.\n\nOn",
    "sections": [
      "intro",
      "installation",
      "usage",
      "the hyper-cmd system",
      "license"
    ],
    "hasApi": true,
    "hasExamples": true,
    "exampleCount": 5,
    "examples": [
      "npm install -g hyperssh // ssh / fuse client stubs\nnpm install -g hypertele // hyperswarm server proxy\nnpm install -g hyper-cmd-utils // keygen utils",
      "This will start announcing the server on the DHT.\n\n### Client\n\nOn the client",
      "Read more about using identities here: https://github.com/prdn/hyper-cmd-docs/blob/main/identity.md\n\nSSHFS (mount a remove fs/folder via ssh)"
    ]
  },
  "patterns": [
    "peer-discovery",
    "dht-discovery"
  ]
}