Reference

Reference is the technical description of how Pear works. It's information-oriented: comprehensive, accurate, and dry. Use it to look up a flag, an API signature, or a configuration field.

If you're trying to accomplish a specific task, see How To. For the design rationale, see Explanations.

In this section

Pear runtime

• Pear CLI — pear init, pear stage, pear seed, pear release, every flag.
• pear-runtime module — the JavaScript API exposed inside a running Pear app.
• Configuration — every key in package.json's pear block.
• Pear API (deprecated) — the older direct-access API. Use the runtime module instead.

Module catalog

• Modules — pear-* libraries: application, UI, common, developer, integration.
• Bare modules — bare-* runtime modules underpinning Pear.

Building blocks

The core peer-to-peer primitives Pear is built on:

• Hypercore, Hyperbee, Hyperdrive, Autobase, HyperDHT, Hyperswarm.

Helpers

Higher-level utilities that combine the building blocks:

• Corestore, Localdrive, Mirrordrive, Secretstream, Compact-encoding, Protomux.

Tools

CLI utilities built on Pear:

• Hypershell, Hypertele, Hyperbeam, Hyperssh, Drives.