Pear DocsModules
Catalog of installable Pear modules—application, UI, common, developer, and integration libraries shipped as `pear-*` packages.
Modules
Pear does not ship a standard library—application, runtime, and integration capabilities are supplied via installable modules prefixed with pear-. As of Pear v3 the core runtime capability is the embeddable Pear OTA (pear-runtime) library; the removed global.Pear API's capabilities live in these modules.
Stability legend
Module lists 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. |
Runtime & deployment libraries
The Pear v3 core: the embeddable runtime and the modules behind the CLI's build and install commands.
| Module | Description | Systems | Stability |
|---|---|---|---|
| pear-runtime | Pear OTA—embeddable runtime with P2P OTA updates, Bare workers & storage |    | experimental |
| pear-runtime-updater | Listens for P2P OTA Pear app updates | | experimental |
| pear-mobile | Embeddable Pear runtime for mobile applications |   | experimental |
| pear-build | Create project deployment folder (pear build) | | stable |
| pear-install | Install applications from peers (pear install) | | stable |
Application libraries
Pear modules related directly to the application environment.
Several modules below (pear-pipe, pear-run, pear-updates, pear-drop, pear-release) target the pear run application environment that was removed in Pear v3—see the Release Overview. Their npm packages remain published; confirm v3 compatibility before adopting them. The equivalent v3 capabilities live in Pear OTA (workers, update events) and the pear provision + pear multisig release flow.
| Module | Description | Systems | Stability |
|---|---|---|---|
| pear-crasher | Uncaught exceptions & uncaught rejections crash logger | | stable |
| pear-message | Send inter-app pattern-matched object messages | | stable |
| pear-messages | Receive object messages that match a given object pattern | | stable |
| pear-pipe | Parent-app-connected pipe, the other end of pear-run pipe | | stable |
| pear-run | Run Pear child app by link. Returns a pipe to the child pipe | | stable |
| pear-updates | Receive platform and application update notifications | | stable |
| pear-user-dirs | Get the path of user-specific directories | | stable |
| pear-wakeups | Receive wakeup events, including link clicks external to app | | stable |
User interface libraries
Pear modules that supply User Interface runtime capabilities.
| Module | Description | Systems | Stability |
|---|---|---|---|
| pear-electron | Pear User-Interface Library for Electron | | stable |
| pear-bridge | Local HTTP bridge for pear-electron applications | | stable |
Common libraries
Pear modules for general usage, including applications per case.
| Module | Description | Systems | Stability |
|---|---|---|---|
| pear-drop | Drop data, including application reset | | stable |
| pear-dump | Synchronize files from link to dir peer-to-peer or from-disk | | stable |
| pear-gracedown | Pear graceful closer. For use with pipe.autoexit = false | | stable |
| pear-info | Read Pear project information by link | | stable |
| pear-link | Parser-Serializer for pear:// links. Includes alias resolution | | stable |
| pear-opwait | Pear operation stream promise wrapper | | stable |
| pear-release | Set application production release version length | | stable |
| pear-seed | Seed or reseed a Pear app drive by link | | stable |
| pear-stage | Synchronize from-disk to app drive peer-to-peer | | stable |
| pear-stamp | Interleave locals into a template, sync and stream | | stable |
Developer libraries
Pear modules to assist with developing & debugging
| Module | Description | Systems | Stability |
|---|---|---|---|
| pear-inspect | Securely enable remote debugging protocol over Hyperswarm | | stable |
| pear-hotmods | For pear-electron UI apps. Frontend framework-agnostic live-reload | | stable |
Integration libraries
Pear modules for runtime integrations. Such as pear-electron.
| Module | Description | Systems | Stability |
|---|---|---|---|
| pear-appdrive | Read-only Hyperdrive API subset interface for application drives | | stable |
| pear-aliases | List of aliases for pear://<alias> links | | stable |
| pear-api | global.Pear API class—removed as of Pear v3, use Pear OTA | | removed |
| pear-changelog | Changelog parsing and diffing | | stable |
| pear-constants | Shared Pear constants | | stable |
| pear-cmd | Command parser & definitions | | stable |
| pear-errors | Shared Pear error types | | stable |
| pear-gunk | Shared builtins, overrides & linker mappings | | unstable |
| pear-ipc | Interprocess Communication library | | stable |
| pear-ref | IO handle reference counter & tracker | | stable |
| pear-rti | Runtime Information state bootstrap for API building | | stable |
| pear-state | Shared state structure & capabilities | | stable |
| pear-terminal | Terminal User Interface library | | stable |
| pear-tryboot | Used with pear-ipc, tries to boot sidecar on connect failure | | stable |
See also
- Bare modules—the lower-level
bare-*runtime modules. - Building blocks—peer-to-peer primitives:
- Helpers—utilities that complement the building blocks:
- Tools—standalone CLI utilities: