Procfile Script

A Visual Studio Code extension to run scripts defined in Procfile files.

Procfile Script in action

How to use

Install the extension
Open a project containing a Procfile or Procfile.dev file
Locate the "Procfile Scripts" section in the Explorer panel of VS Code
Click the 'play' button on the right of a script to run it, or on the Procfile itself to run all scripts.
Click the 'stop' button on the right to stop the running script or Procfile.

The extension supports standard Procfile format:

process_name: command to run

It also supports the Procfile.dev format, which is commonly used for development environments.

web: node server.js
worker: node worker.js

The Procfile.dev can contain multiple scripts, and the extension will display them in a hierarchical tree structure:

- Procfile.dev
  - web
  - js
  - css
- Procfile
  - web
  - worker

The following files are automatically recognized:

The extension offers the following configuration options:

procfile-script.files: Array of Procfile filenames to detect (default: ["Procfile", "Procfile.dev"])
procfile-script.runner: Command used to run Procfile files (default: "foreman")

You can customize these settings in VS Code's settings:

{
  "procfile-script.files": ["Procfile", "Procfile.dev", "Procfile.local"],
  "procfile-script.runner": "foreman"
}

Enjoy!