Documentation
v0.1
Ask or search…
⌃K
Links

Getting Started

Installation Instructions

Installing OWASP Four Clover is a straightforward process. Follow these steps to get started:

Step 1. Download the Binary

  1. 1.
    Go to the GitHub Releases page for Four Clover.
  1. 2.
    Choose the appropriate release version for your operating system (e.g., Windows, Linux, macOS).
  2. 3.
    Download the binary file for the release.

Step 2. Add to PATH (Optional)

🪟 For Windows

Locate Binary

  • After downloading the Four Clover binary, remember the directory where it's saved.

Add to PATH

  • Press Win + S to open the Windows search bar.
  • Type "Environment Variables" and select "Edit the system environment variables."
  • In the System Properties window, click the "Environment Variables" button.
  • Under "System variables," select the "Path" variable and click "Edit."
  • Click "New" and add the directory path where the Four Clover binary is located.
  • Click "OK" to save changes.

Verify Installation

  • Open a new command prompt or PowerShell window.
  • Run the following command to verify that Four Clover is accessible from anywhere:
fourclover version
🐧 For Linux/macOS

Locate Binary and Add Executable Permissions

  • After downloading the Four Clover binary, remember the directory where it's saved.
  • Navigate to the directory where you downloaded the binary.
  • Run the following command to add executable permissions:
chmod +x fourclover

Edit Bash Profile (Linux) or Bash Profile / Zshrc (MacOS)

  • Open a terminal.
  • Run the following command to open the appropriate configuration file:
nano ~/.bashrc # For Linux
nano ~/.bash_profile # For MacOS
nano ~/.zshrc # For MacOS (if using Zsh)
  • Add the following line at the end of the file, replacing /path/to/fourclover with the actual path to the Four Clover binary:
export PATH=$PATH:/path/to/fourclover
  • Press Ctrl + O to save the file, then press Ctrl + X to exit the text editor.

Apply Changes

  • Run the following command in the terminal to apply the changes to your current session:
source ~/.bashrc # For Linux
source ~/.bash_profile # For MacOS
source ~/.zshrc # For MacOS (if using Zsh)
Verify Installation
  • Open a new terminal.
  • Run the following command to verify that Four Clover is accessible from anywhere:
fourclover version

Well done!