Documentation

Installation

macOS Setup (Important)

Because Redact is a compiled binary not signed by the Apple Developer Store, macOS will block it by default.

  1. Download and Unzip the file.
  2. Open your Terminal.
  3. Navigate to the folder: cd ~/Downloads/redact
  4. Allow execution: chmod +x redact
  5. First Run: Right-click the file in Finder and select "Open", or go to System Settings > Privacy & Security and click "Open Anyway".
Windows Setup

Unzip the folder. You can run redact.exe directly from PowerShell or Command Prompt. We recommend adding the folder to your system PATH for easy access.

Linux Setup

Ensure you give the binary executable permissions: chmod +x redact.

Optional Dependencies

Redact works out-of-the-box for Images and PDFs. However, video processing requires external tools installed on your system PATH.

FFmpeg

Required for standard video scrubbing (re-muxing).

ExifTool

Required for the --nuke aggressive scrub flag.

CLI Usage

Clean a single image:

./redact scrub -i photo.jpg

Aggressive Video Scrub (Nuke Mode):

./redact scrub -i video.mp4 --nuke
Note: Requires exiftool to be installed on your system if not bundled.

ISP Padding:

./redact scrub -i doc.pdf --pad