577c4c1bec
* Remove `--` for app option passthrough Changed since `paparam` was used for parsing command line options: 85892a6a32a84ae42a548f8e3ac0b5dbedd70c80 Now uses `cmd.rest` for app args. * Use `Pear.config.args` for howto scripts * Update "starting a pear desktop project" guide to match template * Remove `--no-ask-trust` flag from `pear run` cli doc This command was replaced by `--no-ask` which was already in the documentation. Updated a reference to `--no-ask-trust` in the 'Sharing a Pear Application' guide. * Fix typos in "Releasing a Pear Application" guide * Correct application storage folder name in hyperbee howto * Add missing `test/index.test.js` in project structure for terminal guide * Remove language about app continuing to run This is no longer true at least as of pear: v0.5114.pqbzjhqyonxprx8hghxexnmctw75mr91ewqw5dxe1zmntfyaddqy / v1.5.0 * Fix extra indention in example code for hypercore howto * Format json in `_template.json` example * Add instructions to set up a minimal `package.json` for testing template Without this, the next step of `pear run --dev .` does not work since `pear` expects a `package.json` file. * Rename hyperbee reader app in hyperdrive howto to avoid name conflict Naming only matters if someone is following the guides and starts each guide from the same root directory. If they do, then `bee-reader-app` from the hyperdrive conflicts with the `bee-reader-app` from the hyperbee howto. * Remove unrelated youtube tutorial from hyperswarm howto * Update guide/creating-a-pear-init-template.md Co-authored-by: David Mark Clements <huperekchunow@googlemail.com> * Fix spelling mistake Co-authored-by: David Mark Clements <huperekchunow@googlemail.com> --------- Co-authored-by: David Mark Clements <huperekchunow@googlemail.com>
Pear by Holepunch
Pear loads applications remotely from peers and allows anyone to create and share applications with peers.
Pear by Holepunch is a combined Peer-to-Peer (P2P) Runtime, Development & Deployment tool.
Build, share & extend unstoppable, zero-infrastructure P2P applications for Desktop, Terminal & Mobile.
Welcome to the Internet of Peers
– Holepunch, the P2P Company
Table of Contents
Pear Runtime
References for Pear Runtime.
The Pear Runtime uses Bare JavaScript runtime, which is a small and modular JavaScript runtime for desktop and mobile. To learn more, see Bare Reference.
Guides
Guides on using the Pear Runtime to build and share P2P applications.
- Getting Started
- Starting a Pear Desktop Project
- Making a Pear Desktop Application
- Starting a Pear Terminal Project
- Making a Pear Terminal Application
- Sharing a Pear Application
- Releasing a Pear Application
- Creating a Pear Init Template
How-tos
Simple How-tos on using the essential building blocks in Pear applications.
- How to connect two peers by key with HyperDHT
- How to connect to many peers by topic with Hyperswarm
- How to replicate and persist with Hypercore
- How to work with many Hypercores using Corestore
- How to share append-only databases with Hyperbee
- How to create a full peer-to-peer filesystem with Hyperdrive
Building blocks
The essential building blocks for building powerful P2P applications using Pear.
| Name | Description | Stability |
|---|---|---|
| Hypercore | A distributed, secure append-only log for creating fast and scalable applications without a backend, as it is entirely P2P. | stable |
| Hyperbee | An append-only B-tree running on a Hypercore. Allows sorted iteration and more. | stable |
| Hyperdrive | A secure, real-time distributed file system that simplifies P2P file sharing and provides an efficient way to store and access data. | stable |
| Autobase | A "virtual Hypercore" layer over many Hypercores owned by many different peers. | experimental |
| Hyperdht | The Distributed Hash Table (DHT) powering Hyperswarm. | stable |
| Hyperswarm | A high-level API for finding and connecting to peers who are interested in a "topic". | stable |
Helpers
Helper modules can be used together with the building blocks to create cutting-edge P2P tools and applications.
| Name | Description | Stability |
|---|---|---|
| Corestore | A Hypercore factory designed to facilitate the management of sizable named Hypercore collections. | stable |
| Localdrive | A file system interoperable with Hyperdrive. | stable |
| Mirrordrive | Mirror a Hyperdrive or a Localdrive into another one. | stable |
| Secretstream | SecretStream is used to securely create connections between two peers in Hyperswarm. | stable |
| Compact-encoding | A series of binary encoding schemes for building fast and small parsers and serializers. We use this in Keet to store chat messages and in Hypercore's replication protocol. | stable |
| Protomux | Multiplex multiple message oriented protocols over a stream. | stable |
Tools
The following tools are used extensively employed in the day-to-day development and operation of applications built on Pear.
| Name | Description | Stability |
|---|---|---|
| Hypershell | A CLI to create and connect to P2P E2E encrypted shells. | stable |
| Hypertele | A swiss-knife proxy powered by HyperDHT. | stable |
| Hyperbeam | A one-to-one and end-to-end encrypted internet pipe. | stable |
| Hyperssh | A CLI to run SSH over the HyperDHT. | stable |
| Drives | CLI to download, seed, and mirror a Hyperdrive or a Localdrive. | stable |
Apps
Applications built using Pear.
- Keet: A peer-to-peer chat and video-conferencing application with end-to-end encryption.
Examples
Collection of example applications that can be used as reference during development.
- Cross-platform Pear App: Cross-platform "Hello World" Pear application for Android and iOS.
- Bare on Mobile: Reference applications for using Bare runtime on Android and iOS.
- React App using Pear: Example application for building Pear applications using React framework.
Stability indexing
Throughout the documentation, indications of stability are provided. Some modules are well-established and used widely, making them highly unlikely to ever change. Other modules may be new, experimental, or known to have risks associated with their use.
The following stability indices have been used:
| Stability | Description |
|---|---|
| stable | Unlikely to change or be removed in the foreseeable future. |
| experimental | New, untested, or have known issues. |
| deprecated | Being removed or replaced in the future. |
| unstable | May change or be removed without warning. |