Skip to content

Installation

To install peppy, run the following command in your terminal:

Terminal window
curl -fsSL https://peppy.bot/install.sh | sh

This installer also sets up the peppy background service and populates the repository index that name-based launches resolve from. To skip that step, set PEPPY_NO_SERVICE_INSTALL=1. The flag skips the repository setup along with the service, so a launch by name then fails with nodes.json5 not found or empty until you run peppy repo init and peppy repo update yourself.

The installer can also unpack a release archive you already have, instead of downloading one:

Terminal window
curl -fsSL https://peppy.bot/install.sh | sh -s -- ./peppy-x86_64-unknown-linux-gnu.tgz

If a daemon is already running, the installer asks for confirmation before replacing it; set PEPPY_FORCE_REINSTALL=1 for non-interactive installs.

VariableEffect
PEPPY_VERSIONVersion to install (default: latest)
PEPPY_HOMEInstall prefix (default: ~/.peppy)
PEPPY_BIN_DIRBinary install directory (default: $PEPPY_HOME/bin)
PEPPY_REPOURLBase URL for downloads (default: https://peppy.bot)
PEPPY_DOWNLOAD_URLOverride the full download URL
PEPPY_NO_PATH_UPDATEIf set, do not update the shell PATH config
PEPPY_FORCE_REINSTALLIf set, skip the confirmation prompt when a daemon is running
PEPPY_NO_ROOT_INSTALLIf set, never use sudo; missing dependencies become hard errors and Apptainer setup is deferred to peppy container setup
PEPPY_NO_SERVICE_INSTALLIf set, skip the service install and the repository init/refresh
PEPPY_NO_CONTAINER_SETUPIf set, skip the Apptainer container setup (useful inside Docker/Podman)

The service installs at user level by default; run peppy service install with sudo for a system-wide install. The snippets below assume the default user-level install. You can verify the service is running with:

Terminal window
systemctl --user status peppy
Managing the service (optional)

peppy ships its own platform-independent service commands, which are what the installer itself runs:

Terminal window
peppy service install # install the background service
peppy service stop # stop it
peppy service uninstall # remove it

To drive the service through the platform’s own service manager instead:

Start the service:

Terminal window
systemctl --user start peppy

Stop the service:

Terminal window
systemctl --user stop peppy

Restart the service:

Terminal window
systemctl --user restart peppy