P2P DocsReference
Authoritative descriptions of the peer-to-peer building blocks, helpers, and tools—Hypercore, Hyperswarm, Autobase, and the rest. Use this when you need a fact, not a tutorial.
Reference is the technical description of how the P2P building blocks work. It's information-oriented: comprehensive, accurate, and dry. Use it to look up an API signature or a module.
If you're trying to accomplish a specific task, see How To. For the design rationale, see How the stack fits together.
Bare is the runtime underneath. A small, zero-core JavaScript runtime with its own docs: the module system, native addons, embedding in native and mobile apps, and compiling to a standalone binary all live on the Bare tab. How the stack fits together maps the layers.
Pear is the platform on top. Install the pear CLI when you want peer-to-peer app distribution, over-the-air updates, and one command to stage and release—the core you write here moves across unchanged. Start on the Pear tab, or read How the stack fits together.
In this section
Building blocks
The core peer-to-peer primitives everything else here is built on:
Helpers
Higher-level utilities that combine the building blocks:
Tools
CLI utilities built on the P2P stack:
For the runtime these modules run on, see Bare's Reference. For Pear's CLI, configuration, and release tooling, see Pear's Reference.
Stability legend
Module pages call out a stability indicator. The four levels:
| Stability | Description |
|---|---|
| stable | Unlikely to change or be removed in the foreseeable future. |
| experimental | New, untested, or has known issues. |
| deprecated | Being removed or replaced in the future. |
| unstable | May change or be removed without warning. |