Getting Started

Welcome! In a matter of minutes you'll be hunting down unused code. By default Periphery runs in trial mode - no signup or credit card required. Results are limited to 25% of source files per build target analyzed. There's no time restriction, and you can try it on as many projects as you like. Let's get started.

Install Homebrew

Periphery is distributed via Homebrew, a package manager popular with many developers using macOS.
Installing Periphery with Homebrew is simple and quick, it also allows you to update Periphery with a single command.

If you're already a Homebrew user, you can skip to the next section.

To install Homebrew, paste the following into a Terminal prompt:

/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

The installer will guide you through the installation process. If you'd like more information on Homebrew please visit brew.sh.

Install Periphery

Now that Homebrew is installed, we need to tell it where to find Periphery releases:

brew tap peripheryapp/periphery

Next, install Periphery itself:

brew cask install periphery

Periphery is now installed! You can now change to your project directory and run:

periphery scan

For further instructions on using Periphery, see Using Periphery.