Install Stencil

Stencil is written in Go with support for multiple platforms. The latest release can be found at Stencil Releases.

Stencil currently provides pre-built binaries for the following:

• macOS (Darwin) for x64, i386, and ARM architectures
• Windows
• Linux

Stencil may also be compiled from source wherever the Go toolchain can run; e.g., on other operating systems such as DragonFly BSD, OpenBSD, Plan 9, Solaris, and others. See https://golang.org/doc/install/source for the full set of supported combinations of target operating systems and compilation architectures.

Quick Install

Homebrew (macOS)

We have a brew formula for Stencil. It is recommended to install Stencil via Homebrew on macOS.

brew install stencil

Binary (Cross-platform)

Download the appropriate version for your platform from Stencil Releases. Once downloaded, the binary can be run from anywhere. You don’t need to install it into a global location. This works well for shared hosts and other systems where you don’t have a privileged account.

Ideally, you should install it somewhere in your PATH for easy use. /usr/local/bin is the most probable location.

Source

Prerequisite Tools

• Git
• Go (at least Go 1.18)

Fetch from GitHub

git clone https://github.com/getoutreach/stencil.git
cd stencil
make
cp ./bin/stencil "$(go env GOPATH)/bin/stencil"

Upgrade Stencil

Upgrading Stencil is as easy as downloading and replacing the executable you’ve placed in your PATH.

Next Steps

Now that you’ve installed Stencil, read the Quick Start guide and explore the rest of the documentation. If you have questions, ask the Stencil community directly by visiting the Stencil discussion Forum.