procfile-util

A tool for parsing, validating, and exporting Heroku-style Procfiles.

Installation

Install on Linux or macOS with the install script:

curl -fsSL https://raw.githubusercontent.com/dokku/procfile-util/master/install.sh | sh

Or via apt (after configuring the dokku/dokku PackageCloud repository):

sudo apt-get install procfile-util

Or via go install:

go install github.com/dokku/procfile-util@latest

See the Getting started guide for binary downloads and building from source.

Usage

Validate a Procfile in the current directory:

procfile-util check

List every process type:

procfile-util list

Show the command for the web process with $PORT substituted:

procfile-util show --process-type web --default-port 3000

See the tasks reference for every subcommand and flag.

Documentation

• Getting started - what a Procfile is, why use procfile-util, installation, and your first Procfile
• Procfile format - syntax, comments, and strict mode
• Tasks - one page per subcommand
• Variable expansion - how show and expand resolve $PORT, --env-file, and --allow-getenv
• Process managers - turning a Procfile into systemd, runit, launchd, sysv, or upstart units
• Dokku integration - how procfile-util fits into a Dokku deploy
• CI usage - linting Procfiles and gating CI steps on process types

License

MIT