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 About Pear.

In this section

Pear

• Pear CLI—covers pear stage, pear seed, pear build, pear install, and every flag.
• Pear OTA—the pear-runtime library and JavaScript API for over-the-air updates inside a running Pear app.
• Configuration—every key in package.json's pear block.
• Pear API (removed)—the older direct-access global.Pear API, removed in v3. Use the Pear OTA (pear-runtime) module instead.

For a curated record of breaking changes and removals across these modules, see the Release Overview.

Bare

The runtime Pear is built on, and the kit for embedding it in native apps:

• Bare runtime API—the Bare global: process properties, lifecycle, addons, threads, IPC.
• Bare CLI—run a script or REPL with the bare command.
• Bare Kit—the Worklet and IPC API for iOS, Android, and React Native.

Per-module API references (also linked from the Bare modules catalog): bare-fs, bare-os, bare-stream, bare-tcp, bare-fetch, bare-crypto, bare-subprocess, bare-rpc, bare-sqlite, bare-broadcast-channel, bare-sdl, bare-module-resolve, bare-module-traverse, bare-addon-resolve, bare-bluetooth-android, bare-bluetooth-apple, bare-module, bare-url, bare-atomics, bare-timers, bare-pipe, bare-semver, bare-form-data, bare-channel, bare-tls, bare-console, bare-structured-clone, bare-ipc, bare-inspector, bare-make, bare-prom-client, bare-posix, bare-mdns-discovery, bare-sidecar, bare-union-bundle, bare-mime, bare-apk.

CI & release

• Desktop release npm scripts—the common package.json scripts in Pear Electron desktop repos.
• Holepunch GitHub Actions—the reusable composite actions in holepunchto/actions for building, signing, publishing, and recovering Pear apps and modules.
• pear-ci GitHub Action—staging a Pear app from CI into a pear:// link with the pear-ci action.

Module catalog

• Modules—the pear-* libraries: application, UI, common, developer, integration.
• Bare modules—the 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.

Stability legend

Module pages call out a stability indicator. The four levels: