Please quickstart

System requirements

Please supports Linux and OSX at the moment. We're internally using Ubuntu Xenial and Sierra but it should work on other reasonably recent distros.


curl | bash

This will download and install the latest version of Please on your system.
It also adds itself to your PATH; you may need to source ~/.bashrc or source ~/.zshrc after install to get that updated.

If you'd prefer more manual installation, grab a tarball off our releases page and extract it yourself; it normally lives in ~/.please but you can put it where you want.

Shell completion

Please comes with a completion script for Bash and zsh built-in.

You can produce it by running plz --completion_script. This is handy to add to your .bashrc or .zshrc, for example:

source <(plz --completion_script)

The script will complete subcommands and flags but most relevantly can also complete build labels by reading BUILD files for you.

Getting started

Run plz init at the root of your repo to create the .plzconfig file. There are many options that can be configured in this file but you can worry about them later - the defaults should be fine to begin with.

You will need to write some BUILD files to define how to compile your code. Carry on to Please Basics which will explain more about it.