Installation

DeadFinder can be installed in several ways, depending on your preference and environment.

Install with Gem

gem install deadfinder
# https://rubygems.org/gems/deadfinder

If you want to use DeadFinder in your Ruby project, add this to your Gemfile:

gem 'deadfinder'
# and `bundle install`

For macOS and Linux users, DeadFinder is available via Homebrew:

brew install deadfinder
# https://formulae.brew.sh/formula/deadfinder

DeadFinder is also available as a Docker image on GitHub Container Registry:

docker pull ghcr.io/hahwul/deadfinder:latest

Run DeadFinder using Docker:

docker run ghcr.io/hahwul/deadfinder:latest deadfinder --help

To build DeadFinder from source, you'll need Ruby 3.4+ installed:

git clone https://github.com/hahwul/deadfinder.git
cd deadfinder
bundle install
bundle exec ruby -I lib bin/deadfinder --help

After installation, verify that DeadFinder is installed correctly:

deadfinder version

You should see the version information displayed.