Skip to main content

Flux CLI

A command-line tool for AI image generation and editing using Flux through the AceDataCloud platform.

Features

  • Text-to-Image Generation — Generate images from text prompts with multiple Flux models
  • Image Editing — Edit existing images using text descriptions (kontext models)
  • Task Management — Query status, batch check, and poll for completion
  • Multiple Models — flux-dev, flux-pro, flux-kontext-pro, flux-kontext-max, flux-2-flex, flux-2-pro, flux-2-max, flux-2-klein
  • Rich Output — Beautiful terminal formatting with --json for scripting

Installation

pip install flux-pro-cli

Quick Start

# Set your API token
export ACEDATACLOUD_API_TOKEN=your_token_here

# Generate an image
flux generate "A majestic mountain landscape at golden hour, photorealistic"

# Generate with a specific model
flux generate "Cyberpunk city with neon lights" -m flux-2-pro

# Generate with aspect ratio (ultra/kontext models)
flux generate "Minimalist logo of a phoenix" -m flux-2-max -s 16:9

# Generate multiple images
flux generate "A red car" --count 2

# Edit an existing image
flux edit "Add sunglasses to the person" --image-url https://example.com/photo.jpg

# Edit with max context model
flux edit "Change background to sunset beach" --image-url https://example.com/img.png -m flux-kontext-max

# Check task status
flux task abc123-def456

# Wait for task completion
flux wait abc123 --interval 5 --timeout 300

# Batch check multiple tasks
flux tasks task-1 task-2 task-3

Commands

Command Description
generate Generate an image from a text prompt
edit Edit an existing image with a text prompt
task Query a single task status
tasks Query multiple tasks at once
wait Wait for a task to complete
models List available Flux models
aspect-ratios List available aspect ratios
config Show current configuration

Models

Model Type Size Input Notes
flux-dev Dev Pixels Fast, good balance (default)
flux-pro Pro Pixels Higher quality
flux-kontext-pro Kontext Aspect ratio Best for editing/style transfer
flux-kontext-max Kontext Aspect ratio Max context for complex edits
flux-2-flex Flux 2 Pixels Fast Flux 2 generation
flux-2-pro Flux 2 Pixels Higher quality Flux 2 generation
flux-2-max Flux 2 Pixels Maximum quality Flux 2 generation
flux-2-klein Flux 2 Pixels Compact Flux 2 generation

JSON Output

All commands support --json for machine-readable output:

flux generate "A red car" --json | jq '.task_id'
flux task abc123 --json | jq '.data[0].image_url'

Configuration

Environment Variable Description Default
ACEDATACLOUD_API_TOKEN API authentication token (required)
ACEDATACLOUD_API_BASE_URL API base URL https://api.acedata.cloud
FLUX_REQUEST_TIMEOUT Request timeout in seconds 1800

You can also use a .env file or pass --token directly.

Docker

docker compose run flux-cli generate "A beautiful sunset"

Development

# Install with dev dependencies
pip install -e ".[all]"

# Run tests
pytest

# Run linter
ruff check .
ruff format --check .

License

MIT License - see LICENSE for details.

FLUX 3 video

Save a JSON request such as {"action":"generate","mode":"t2v","prompt":"Waves at sunset","duration":5,"generate_audio":false} in request.json, then run flux video --request-file request.json. The request is validated before submission. Use i2v with keyframes, v2v with start_video, or draft_enhance with an owned platform draft_task_id. Draft availability is temporary.

Video generation uses POST /flux/videos with action=generate (default) and mode=t2v/i2v/v2v/draft_enhance. The flux video --request-file request.json command validates the generation mode and outputs JSON. Requests are asynchronous by default; use flux task/flux wait for final delivery. Set async=false to wait synchronously.

Metadata

Release files for flux-pro-cli 2026.10.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for flux-pro-cli 2026.10.2.0
File Size Uploaded
flux_pro_cli-2026.10.2.0.tar.gz 16.1 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for flux-pro-cli 2026.10.2.0
File Interpreter ABI Platform
flux_pro_cli-2026.10.2.0-py3-none-any.whl Python 3 none any Details

Total release size: 31.7 kB

Release files / flux_pro_cli-2026.10.2.0.tar.gz

Download URL flux_pro_cli-2026.10.2.0.tar.gz
Size 16.1 kB
Tags Source
SHA-256 checksum
How to use checksums
3b5766ae84ac2d811d284964dcb39360f58f1ed636aa36ff36394cbdca3567bf
BLAKE2b-256 checksum
How to use checksums
67739fe6cb8e386a8dbf7090cfb430e6f1e34a4347914f28e9a9dd94d46acaca
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.3

Release files / flux_pro_cli-2026.10.2.0-py3-none-any.whl

Download URL flux_pro_cli-2026.10.2.0-py3-none-any.whl
Size 15.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
5d347512364546103e670fa099d0634a6aeeb579bc96eb3ba842057fda6ad308
BLAKE2b-256 checksum
How to use checksums
011f9f4ea125b9645a8c2d723620c6b81d40d5335ebcd778b0071bfc12da03a8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.3
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page