Skip to content

Homebrew formula for easy installation #5

@bad-antics

Description

@bad-antics

Description

LogReaper should be installable via Homebrew on macOS and Linux so users can run:

brew install bad-antics/tap/logreaper

Details

  • Create a Homebrew tap repo (bad-antics/homebrew-tap) or add to the main repo
  • Formula should:
    • Download the release tarball
    • Build from source with make
    • Install binary to prefix
    • Install man page (once Add man page (logreaper.1) #1 is done)
    • Run basic test (logreaper --help)
  • Consider also adding to the main Homebrew core once we have enough stars/adoption

Example Formula

class Logreaper < Formula
  desc "High-speed log analysis & forensics tool"
  homepage "https://github.com/bad-antics/nullsec-logreaper"
  url "https://github.com/bad-antics/nullsec-logreaper/archive/refs/tags/v1.0.0.tar.gz"
  license "MIT"

  depends_on "gcc" => :build

  def install
    system "make"
    bin.install "logreaper"
  end

  test do
    assert_match "LogReaper", shell_output("#{bin}/logreaper --help")
  end
end

Acceptance Criteria

  • brew install bad-antics/tap/logreaper works
  • Formula tested on macOS and Linux
  • CI for the tap repo validates the formula

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions