Installation
Flux-CLI can be installed in several ways depending on your needs.
Prerequisites
- Python 3.10+ — Required for running Flux-CLI
- An API key — From OpenRouter (default) or any OpenAI-compatible provider
Option 1: Local Development (Recommended)
Clone the repository and install dependencies:
Clone & Install
Creates an isolated Python environment and installs all dependencies.
git clone https://github.com/manmit-s/flux-cli.git
cd flux-cli
# Create and activate virtual environment
python -m venv .venv
# On Windows:
.venv\Scripts\activate
# On macOS/Linux:
source .venv/bin/activate
# Install dependencies
pip install -r requirements.txtOption 2: Via Pip (When Published)
Install via pip
Standard pip installation when the package is published to PyPI.
# Install globally
pip install flux-cli-ai
# Or install in a virtual environment
python -m venv .venv
source .venv/bin/activate
pip install flux-cli-aiOption 3: Via Pipx (Recommended for CLI Tools)
Install via pipx
Pipx creates isolated environments for CLI tools and adds them to your PATH.
# Install pipx if you don't have it
python -m pip install --user pipx
python -m pipx ensurepath
# Install flux-cli-ai
pipx install flux-cli-ai
# Launch from anywhere
fluxVerify Installation
Verify installation
If installed correctly, you should see the help menu with available commands.
# Check that the CLI is installed
flux --help
# Or run directly from the repository
python main.py --helpVirtual Environment Best Practice
Always use a virtual environment for Python projects. It prevents dependency conflicts and keeps your system Python clean. Flux-CLI uses the .venv directory (gitignored by default).