Installation

Download and install s3finder on your system.

Download Binary

The easiest way to install s3finder is to download a pre-built binary for your platform.

Platform Architecture Download
Linux amd64 s3finder-linux-amd64.tar.gz
Linux arm64 s3finder-linux-arm64.tar.gz
macOS Intel s3finder-darwin-amd64.tar.gz
macOS Apple Silicon s3finder-darwin-arm64.tar.gz
Windows amd64 s3finder-windows-amd64.zip
Windows arm64 s3finder-windows-arm64.zip

Linux / macOS

bash 
# Download (replace with your platform)
curl -LO https://github.com/xeloxa/s3finder/releases/latest/download/s3finder-darwin-arm64.tar.gz

# Extract
tar -xzf s3finder-darwin-arm64.tar.gz

# Move to PATH
sudo mv s3finder /usr/local/bin/

# Verify installation
s3finder version

Windows

powershell 
# Download and extract
Invoke-WebRequest -Uri "https://github.com/xeloxa/s3finder/releases/latest/download/s3finder-windows-amd64.zip" -OutFile "s3finder.zip"
Expand-Archive -Path "s3finder.zip" -DestinationPath "C:\Tools\s3finder"

# Add to PATH (run as Administrator)
$env:Path += ";C:\Tools\s3finder"
[Environment]::SetEnvironmentVariable("Path", $env:Path, [EnvironmentVariableTarget]::Machine)

# Verify
s3finder version

Homebrew

If you use Homebrew on macOS or Linux:

bash 
brew install xeloxa/tap/s3finder

Go Install

If you have Go 1.21+ installed:

bash 
go install github.com/xeloxa/s3finder/cmd/s3finder@latest
Make sure $GOPATH/bin is in your PATH.

Build from Source

bash 
# Clone the repository
git clone https://github.com/xeloxa/s3finder.git
cd s3finder

# Build for current platform
make build

# Or build for all platforms
make build-all

Requirements

  • Go 1.21 or later
  • Git
  • Make (optional)

Verify Installation

bash 
s3finder version
# Output: s3finder version v1.2.4

s3finder --help
# Shows all available commands and flags

Platform Notes

Windows: Use Windows Terminal or PowerShell for best color support.

macOS: Both Intel and Apple Silicon are natively supported. No Rosetta required.

Linux: ARM64 builds available for Raspberry Pi and AWS Graviton.

Next Steps

Head over to the Quick Start guide to run your first scan.