nfpm/www/docs/install.md

Install

You can install the pre-compiled binary (in several different ways), use Docker or compile from source.

Bellow you can find the steps for each of them.

Install the pre-compiled binary

homebrew tap

brew install goreleaser/tap/nfpm

homebrew

brew install nfpm

!!! info The formula in homebrew-core might be slightly outdated. Use our homebrew tap to always get the latest updates.

scoop

scoop bucket add goreleaser https://github.com/goreleaser/scoop-bucket.git
scoop install nfpm

apt

echo 'deb [trusted=yes] https://apt.fury.io/goreleaser/ /' | sudo tee /etc/apt/sources.list.d/goreleaser.list
sudo apt update
sudo apt install nfpm

yum

echo '[goreleaser]
name=GoReleaser
baseurl=https://yum.fury.io/goreleaser/
enabled=1
gpgcheck=0' | sudo tee /etc/yum.repos.d/goreleaser.repo
sudo yum install nfpm

deb, apk and rpm packages

Download the .deb, .rpm or .apk from the releases page and install them with the appropriate tools.

shell script

curl -sfL https://install.goreleaser.com/github.com/goreleaser/nfpm.sh | sh

go install

go install github.com/goreleaser/nfpm/v2/cmd/nfpm@latest

Manually

Download the pre-compiled binaries from the releases page and copy them to the desired location.

Running with Docker

You can also use it within a Docker container. To do that, you'll need to execute something more-or-less like the following:

docker run --rm -v $PWD:/tmp/pkg goreleaser/nfpm package \
	--config /tmp/pkg/foo.yml \
	--target /tmp \
	--packager deb

Compiling from source

Here you have two options:

If you want to contribute to the project, please follow the steps on our contributing guide.

If you just want to build from source for whatever reason, follow these steps:

clone:

git clone https://github.com/goreleaser/nfpm
cd nfpm

get the dependencies:

go mod tidy

build:

go build -o nfpm ./cmd/nfpm

verify it works:

./nfpm --version