OverviewFilesCommitsIssuesDocsReleasesPeers

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

50 lines · json ref:
{
  "repo": "pear",
  "timestamp": "2026-01-16T23:39:33.885Z",
  "entryPoint": "./boot.js",
  "exports": {
    "packageJson": {
      "main": "./boot.js"
    }
  },
  "api": {
    "file": "./boot.js",
    "exports": [],
    "classes": [
      {
        "name": "API"
      }
    ],
    "functions": [
      {
        "name": "getBootType"
      }
    ]
  },
  "readme": {
    "content": "# 🍐 Pear\n\n## Setup\n \nVia Node.js's npm's `npx`:\n\n```sh\nnpx pear\n```\n\nThis installs Pear onto the system. \n\nTo complete the setup, be sure to follow instructions for setting `PATH` as output by the `npx pear` command.\n\n### Help\n\n```sh\npear help <cmd>\n```\n\n```sh\npear <cmd> --help\n```\n\n```sh\npear <cmd> -h\n```\n\n## Documentation\n\n[Documentation](https://docs.pears.com)\n\n## Platform Development\n\nPlatform development is generally referred to as **localdev**.\n\n**Clone:**\n\n```sh\ngit clone https://github.com/holepunchto/pear && cd pear\n```\n\n**Install deps:**\n\n```sh\nnpm install\n```\n\nBootstrap the runtime binaries with\n\n```sh\nnpm run bootstrap [KEY]\n```\n\nKey defaults to production key `npm run bootstrap` bootstraps from production runtimes.\n\nFirst run will install runtimes in `by-arch`, create platform directory called `pear` and add a `pear.dev` symlink (Linux, Mac)or `pear.ps1` and `pear.cmd` files (Windows). These are system-specific and .gitignore'd.\n\nUse `./pear.dev` (`\\\\pear.ps1` / `\\\\pear.",
    "sections": [
      "intro",
      "setup",
      "documentation",
      "platform development",
      "drives",
      "license"
    ],
    "hasApi": false,
    "hasExamples": true,
    "exampleCount": 8,
    "examples": [
      "This installs Pear onto the system. \n\nTo complete the setup, be sure to follow instructions for setting `PATH` as output by the `npx pear` command.\n\n### Help",
      "",
      ""
    ]
  },
  "patterns": [
    "peer-discovery",
    "stream-multiplexing",
    "binary-encoding",
    "cryptography",
    "streaming"
  ]
}