ForgeFoundary Installation Guide
This document explains how to install ForgeFoundary on your system, including the requirements and the provided installation scripts.
Requirements
Before installing ForgeFoundary, make sure you have the following installed:
- PHP (version 8.2 or higher)
Download PHP - Composer (PHP dependency manager)
Download Composer
ForgeFoundary depends on PHP and Composer to run and manage dependencies.
Installation Scripts
ForgeFoundary provides two scripts to install the tool, depending on your operating system.
1. Unix / Linux / macOS
Script: install.sh
How to run:
chmod +x install.sh
./install.sh
The script will:
- Ask for the installation directory (default:
~/ForgeFoundary). - Clone the ForgeFoundary repository to the specified folder.
- Install PHP dependencies using Composer.
- Attempt to make the
ForgeFoundarycommand available globally (requires write access to/usr/local/bin).
If the script cannot link globally, you can manually add the install directory to your PATH.
2. Windows
Script: install.ps1
How to run:
Open PowerShell with administrative rights and execute:
Set-ExecutionPolicy Bypass -Scope Process -Force
.\install.ps1
The script will:
- Ask for the installation directory (default:
$HOME\ForgeFoundary). - Clone the ForgeFoundary repository to the specified folder.
- Install PHP dependencies using Composer.
- Optionally, guide you to make
ForgeFoundaryaccessible globally.
Next Steps
After installation, you can run the tool using:
ForgeFoundary dry-run