OverviewFilesCommitsIssuesDocsReleasesPeers

holepunchto-kb / skills / git-remote-punch-transport / api-extract.json

51 lines · json ref:
{
  "repo": "git-remote-punch-transport",
  "timestamp": "2026-01-16T23:56:01.171Z",
  "entryPoint": "index.js",
  "exports": {
    "packageJson": {
      "main": "index.js"
    }
  },
  "api": {
    "file": "index.js",
    "exports": [],
    "classes": [],
    "functions": [
      {
        "name": "list"
      },
      {
        "name": "listForPush"
      },
      {
        "name": "push"
      },
      {
        "name": "fetch"
      }
    ]
  },
  "readme": {
    "content": "# Git-Remote-Punch transport\n\nGit remote helper for hyperswarm git transport.\n\n``` bash\nnpm install -g https://github.com/holepunchto/git-remote-punch-transport\ngit clone punch://public-key:repository\n```\n\n## Server\n\nThe client of this remote helper depends on the repository server running git-punch-server. This server is responsible for packet negotiation and Git daemon forwarding.\n\nTo start the server, run:\n\n``` bash\n  git-punch-server start [--seed=<key-pair-seed>] [--bootstrap=<bootstrap-url>] [--basedir=<directory>]\n  # Listening on key: 3f9b09e0831b13e755d4b0af079a5b56f38efed122d561af5069e1e35cf2a1c2\n\n```\n\n## Example\n\n``` bash\n  npm install -g https://github.com/holepunchto/git-remote-punch-transport\n  cd /tmp\n  mkdir test-repository\n  cd test-repository\n  git init --bare\n  touch git-daemon-export-ok\n  git-punch-server start --basedir=/tmp\n  # Listening on key: <public-key>\n  git clone punch://<public-key>/test-repository\n```\n\n",
    "sections": [
      "intro",
      "server",
      "example"
    ],
    "hasApi": false,
    "hasExamples": true,
    "exampleCount": 2,
    "examples": [
      "## Server\n\nThe client of this remote helper depends on the repository server running git-punch-server. This server is responsible for packet negotiation and Git daemon forwarding.\n\nTo start the server, run:",
      "## Example"
    ]
  },
  "patterns": [
    "peer-discovery",
    "dht-discovery",
    "binary-encoding",
    "cryptography",
    "streaming"
  ]
}