Pear Docs

Getting started

Install the pear CLI, then ship an app you already have—build, stage, provision, and seed a release that users get over the air.

This page gets the pear CLI onto your machine and points you at how to build, stage, provision, and seed a release of an app you already have. Don't have an app yet? Build one on P2P—a type-along tutorial that builds a peer-to-peer chat app from scratch, then reshapes it into the production hello-pear-electron scaffold this page's release steps assume.

Install Pear

Get the pear CLI from install.pears.com:

curl https://install.pears.com/pear.sh | sh

Follow the PATH instructions the installer prints, then run pear directly. See Install & upgrade for the Homebrew and npm-global notes and upgrade details. The tetherto/pear image runs Pear inside Ubuntu with pear and pear-install ready to go—handy for trying the CLI without installing anything locally.

New to the CLI? Run pear --menu (Pear 3.2.0+) to browse every command from a filterable list and fill in its flags as a form, instead of memorizing them. See Browse commands with the interactive menu.

Don't have an app yet?

Clone an official boilerplate instead of starting from a blank folder—each one embeds a pear-runtime-family module for peer-to-peer over-the-air updates, so the release steps below apply as soon as you've made one yours.

Prefer to build the peer-to-peer logic yourself first, rather than clone a template? Build a peer-to-peer chat is the full type-along tutorial.

Already have a built app? Ship it

The deep, step-by-step guides for every part of the release pipeline already exist as how-tos—this section signposts into them rather than repeating them:

For the concepts behind that flow—what staging, provisioning, and multisig actually do and why—see Release pipeline.

Where to go next

Last updated on

Was this helpful?

On this page