Installation

This section will guide you through the installation process of Pup.

Prerequisites

Before proceeding with the installation, ensure that you have the following installed on your system:

  • Deno (version 1.44.x or higher): You can install Deno by following the official Deno instructions.

Installing or upgrading Pup

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

deno run -Ar jsr:@pup/pup setup

This command downloads the latest version of Pup and installs it on your system.

  • The -A flag grants all permissions.
  • The -r flag ensures no cache is used.
  • Adding --channel prerelease installs the latest pre-release version of Pup.

If you already have Pup installed and want to upgrade to the latest version, you can use:

pup upgrade

The upgrade command support the following parameters:

  • --version: Install, upgrade, or downgrade to a specific version.
  • --channel <channel>: Defaults to stable, but you can also install the prerelease or canary channel.
  • --all-permissions: This flag grants Pup full permissions, diverging from the principle of least privilege, which is the default behavior. Use this cautiously due to potential security implications. It's important to note that this setting is exclusive to Pup; every child process initiated retains its own distinct permissions as configured, respecting their individual least privilege settings.
  • --unsafely-ignore-certificate-errors[=list,of,hosts]: Should almost never be used, and certainly not in production. This parameter is passed along to Deno as-is, and makes Pup and all Deno subprocess ignore certificate errors. Has to be speficied on both setup and upgrade. It is better to pass this parameter to selected processes using the command in pup.json if you really need it.

The upgrader will check if your currently installed version of Deno is compatible with Pup and suggest an upgrade if necessary.

After the installation or upgrade is complete, you will see a message indicating the installation path of the Pup executable. To use the pup command from any location in your terminal, ensure that the installation path is added to your system's PATH environment variable.

Release channels

The available channels are:

  • stable: The latest stable release of Pup. This is recommended for production environments where stability is a priority.

  • prerelease: This channel offers pre-release versions of Pup that include new features and improvements. It is suitable for users who want to test the latest enhancements before they are officially released.

  • canary: The canary channel provides the most up-to-date and cutting-edge versions of Pup. It includes the latest changes and may not be as stable as the other channels. It is primarily intended for developers and early adopters who want to stay on the bleeding edge of Pup's development. Based on the current state of the dev repo of the github repository.

Note Built-in plugins, such as splunk-hec and webinterace does not work with canary versions right now.

Each channel serves different purposes, so choose the one that best fits your needs and requirements.

Verifying the Installation

To verify that Pup has been installed correctly, run the following command in your terminal:

pup --version

If Pup is installed successfully, you should see the current version number. Now you're ready to start using Pup to manage your processes.