Overview

Pup is a powerful process manager for Deno, designed to simplify the management of your applications and services. Here are some of the key features:

  • Cross-platform and wide OS compatibility: Manage processes for various languages and platforms, such as Deno, Node.js, Python, and Ruby on Windows, macOS, and Linux.
  • Process management: Define, control, and manage your processes with simple commands and configuration options.
  • Multiple start/restart policies: Set up processes to start automatically, on a schedule (using cron expressions), or when files change.
  • Service management: Built-in installer for Linux (sysvinit, systemd, upstart), macOS, and Windows services.
  • Clustering and load balancing: Scale your application seamlessly with built-in clustering and load balancing capabilities.
  • Plugins: Extend Pup's functionality with custom plugins for additional features and integrations.
  • Process Telemetry and IPC: Pup can gather telemetry data from Deno client processes, such as memory usage and current working directory, providing deeper insights into managed processes. The telemetry feature also enables inter-process communication, allowing connected processes to interact with one another.

Note Programmatic usage, process telemetry, and IPC are currently available only when running Deno client processes.

Pup is centered on a single configuration file, ideally named pup.json or pup.jsonc, which manages all aspects of the processes to be executed, including their execution methods and logging handling.

Quick Start

Installation

To install Pup, open your terminal and execute the following command:

deno run -Ar https://deno.land/x/pup/pup.ts setup --channel prerelease

This command downloads the latest version of Pup and installs it on your system. The --channel prerelease option is included as there is no stable version of Pup yet. Read more abour release channels here.

Configuration

  1. Start by generating a new configuration file called pup.json at your project root. This can be achieved using Pup's built-in helper with the following command:

    pup init --id "my-server" --cmd "deno run -A server.ts" --autostart

  2. (Optional) In case you have an additional task to execute, such as a cleanup script, you can make use of pup append. The following example shows how to add an extra task that use the cron start policy:

    pup append --id "my-task" --cmd "deno run -A task.ts" --cron "0 0 * * * *"

  3. Now, start your ecosystem:

    pup run

  4. (Optional) To make your ecosystem function as a system service, install it using pup install. This works with systemd, sysvinit, upstart, launchd, and Windows service manager:

    pup install --name my-service