Flux DocsInstallation Guide
Learn how to install Flux on your system and get started with package management.
System Requirements
Before installing Flux, make sure your system meets the following requirements:
- Node.js 16.0.0 or later
- macOS, Windows (including WSL), or Linux
- At least 100MB of disk space for the Flux installation
Installation Methods
There are several ways to install Flux, depending on your preferences and requirements. Choose the method that best suits your needs:
macOS/Linux
Install Flux using Homebrew (macOS/Linux)
If you have Homebrew installed, you can easily install Flux by running the following command in your terminal:
brew install fluxInstall Flux using cURL (macOS/Linux) / Windows (WSL)
Alternatively, you can use cURL to download and install Flux:
curl -fsSL https://flux.sh/install | shVerify Installation
After installation, verify that Flux is installed correctly by running the following command:
flux versionIf the installation was successful, you should see the version of Flux displayed in the terminal. If you encounter any issues, refer to the Flux documentation for troubleshooting tips.
Windows (Native)
Download Flux for Windows
Download Flux executable from the Flux Releases page.
Install Flux on Windows
Open the downloaded file and follow the installation instructions.
Add Flux to PATH
Ensure that the directory where Flux is installed is added to your system's PATH environment variable. This allows you to run Flux commands from any command prompt or PowerShell window.
Verify Installation
Open a command prompt or PowerShell window and run the following command to verify that Flux is installed correctly:
flux versionIf the installation was successful, you should see the version of Flux displayed in the terminal. If you encounter any issues, refer to the Flux documentation for troubleshooting tips.
Manual
Download Flux Binary
Download the latest Flux binary from the Flux Releases page.
Add Flux to PATH
Extract the downloaded file to a directory of your choice. Add the directory to your system's PATH environment variable to make it accessible from the command line.
Verify Installation
Open a command prompt or PowerShell window and run the following command to verify that Flux is installed correctly:
flux versionIf the installation was successful, you should see the version of Flux displayed in the terminal. If you encounter any issues, refer to the Flux documentation for troubleshooting tips.
Updating Flux
To update Flux to the latest version, you can use the self-update command:
flux self-updateThis command will download the latest version of Flux and replace the existing binary with the updated version.
Uninstalling Flux
To uninstall Flux, you can use the following command:
macOS/Linux
Uninstall Flux using Homebrew (macOS/Linux)
If you installed Flux using Homebrew, you can uninstall it by running the following command in your terminal:
brew uninstall fluxUninstall Flux using cURL (macOS/Linux) / Windows (WSL)
If you installed Flux using cURL, you can uninstall it by running the following command:
curl -fsSL https://flux.sh/uninstall | shWindows (WSL) / (Native)
curl -fsSL https://flux.sh/uninstall | shManual
To manually uninstall Flux, simply delete the Flux binary from the directory where you installed it. If you added Flux to your system's PATH, you may also want to remove that entry from your PATH environment variable.
Troubleshooting
If you encounter any issues during installation or usage, refer to the Flux documentation for troubleshooting tips. You can also check the Flux GitHub repository for known issues and their solutions.