Setup

Planck runs on macOS and Linux.

Planck requires no external dependencies. (There is no need for either the Java JVM or Node.js.)

Homebrew

Install

The easiest way to install Planck on macOS is via Homebrew:

brew install planck 

On Ubuntu you can use apt-get:

sudo add-apt-repository ppa:mfikes/planck sudo apt-get update sudo apt-get install planck 

For other Linux distros, binary downloads are available for some distros. Otherwise, see Building below.

Install Master

If you'd like to use Homebrew to install the latest unreleased version of Planck (directly from master in the GitHub repository), you can do the following:

brew remove planck brew install --HEAD planck 

Building

To build Planck on Linux or macOS, get a copy of the source tree, install the needed dependencies and run

script/build 

This results in a binary being placed in planck-c/build.

You can then optionally install Planck, the plk script, and associated man pages via

script/install 

Bug Reporting

If you happen to encounter any issues with Planck, issues are tracked on GitHub at https://github.com/planck-repl/planck/issues.