A simple, cross-platform system package manager.
Go to file
Stephen McQuay 3e4ccb3376
Describe components that make up the project
2018-02-24 20:09:17 -08:00
.gitignore Adds git ignore 2018-02-24 20:08:47 -08:00
LICENSE init 2018-02-24 20:08:47 -08:00
README.md Describe components that make up the project 2018-02-24 20:09:17 -08:00

README.md

pm: a simple, cross-platform system package manager

pm exists amid a set of trade-offs in distributing software. The ideas behind pm were born at a time when:

  • There was no overlap in the Venn diagram of system package managers that offered both strong security promises (signed packages) and permissive licensing (most are GPL).
  • There was reason to suspect that Unix systems might be shipped without scripting languages; software like brew would cease to work and engineers would be left without a way to fetch and install software.
  • Engineers wanted to deploy software to a variety of Unix-like environments using a single system.
  • Engineers wanted a simple-to-reason-about system that used familiar Unix primitives as building blocks to distribute their software.

Simplicity is a principal design goal of this project. When offered an opportunity to chose between two designs the design that requires less mental scaffolding to describe or implement should be used. As a concrete example: transitive dependency calculations are implemented, but supporting compatible version ranges are not.

The project is currently in early design phases, and this document describes the high-level approach of the project.

Components

There are two main components to this project.

  1. pm is the name of the client-side cli command. This is the tool used to fetch, install, verify, create, upload, etc. packages.
  2. pmd is the name of the server-side component. It hosts packages (over http for now), available package metadata, and cryptographic public key information to clients.

Securely installing the pm command is important. Be sure to verify its contents before use.