Files
sif/docs/installation.md
vmfunc 94b99ade5a docs: fix broken -all example and document -sh
- the readme headline used -all, which isn't a real flag (goflags fatals
  on unknown flags), so the three -all examples now use actual flags
- document the new -sh security-header scan in the readme table, usage.md
  and scans.md, and fix the -headers section (it dumps headers; -sh grades
  them)
- bump the documented go version 1.23 -> 1.25 to match go.mod
2026-06-08 18:53:06 -07:00

1.5 KiB

installation

from releases

download the latest binary for your platform from releases.

linux

# download
curl -LO https://github.com/vmfunc/sif/releases/latest/download/sif-linux-amd64

# make executable
chmod +x sif-linux-amd64

# move to path (optional)
sudo mv sif-linux-amd64 /usr/local/bin/sif

macos

# intel
curl -LO https://github.com/vmfunc/sif/releases/latest/download/sif-macos-amd64

# apple silicon
curl -LO https://github.com/vmfunc/sif/releases/latest/download/sif-macos-arm64

chmod +x sif-macos-*
sudo mv sif-macos-* /usr/local/bin/sif

windows

download sif-windows-amd64.exe from releases and add to your PATH.

from source

requires go 1.25+

git clone https://github.com/dropalldatabases/sif.git
cd sif
make

the binary will be created in the current directory.

install to system

sudo make install

this installs to /usr/local/bin/sif.

uninstall

sudo make uninstall

verify installation

./sif -h

you should see the help output with available flags.

updating

from releases

download the new binary and replace the old one.

from source

cd sif
git pull
make clean
make

modules directory

sif looks for modules in these locations:

  • built-in: modules/ directory next to the sif binary
  • user modules: ~/.config/sif/modules/ (linux/macos) or %LOCALAPPDATA%\sif\modules\ (windows)

user modules override built-in modules with the same id.