About
Flue is a tiny bridge that lets coding harness drive professional desktop software - Photoshop, Premiere, Blender, Unity, and more - directly from the shell. Flue is not an MCP server. The agent sends a script through a small bridge command, the bridge runs it inside the app's own automation runtime, and the app returns JSON.
agent shell -> bridge command -> app scripting runtime -> JSON result
This is the entry point to the Flue framework. The adapter docs, bridge scripts, and supporting files below are installed by pip install flue && flue setup. Ask your human for permission to run that first if they are not present.
Available Adapters
adapters/3dsmax/APP.mdadapters/after_effects/APP.mdadapters/audition/APP.mdadapters/blender/APP.mdadapters/excel/APP.mdadapters/houdini/APP.mdadapters/illustrator/APP.mdadapters/indesign/APP.mdadapters/photoshop/APP.mdadapters/powerpoint/APP.mdadapters/premiere/APP.mdadapters/unity/APP.mdadapters/word/APP.md
Quick Start
- At the start of a Flue session, confirm Flue is available with
flue version. If it is not found, ask your human for permission to runpip install flue && flue setup. - Read
adapters/<app>/APP.mdfor the app you are about to use. - Search
adapters/<app>/docs/api-index.txtwithrgfor relevant symbols. - Prefer
py -m flue.cli context <app>on Windows, orpython3 -m flue.cli context <app>on macOS/Linux, to inspect the live app state. - Prefer
py -m flue.cli run <app> --stdinon Windows, orpython3 -m flue.cli run <app> --stdinon macOS/Linux, for one-off scripts.
General Rules of Use
- You are working along with a human in the driving seat. Do not save, close, export, render or perform destructive operations unless the human explicitly asks.
- Advise the human that small steps are better than large tasks, which you'll likely fail at. Keep collaboration scope manageable.
- Bound scripts carefully to avoid crashing the host: keep scripts small and targeted.
- All bridge scripts run from workspace root; accepts code through argv,
--stdin, or--file; return JSON on stdout for success or failure. - Be skeptical of your pretraining: introspect the running app and consult vendor documentation rather than trying to invent operations.
- Flue was developed and tested against specific app and OS versions. One could expect local quirks, version mismatches and blocked automation paths. You need to understand the bridge architecture and make small, local compatibility fixes or scaffolds when needed, so the adapter works in the user's actual environment (without rewriting the full project). Make these small and robust, so that they work between sessions.
- Read these reference files if you don't have them in the session memory (available post-setup):
shared/coexistence.mdshared/bridge-contract.mddocs/setup.mddocs/known-issues.md
Debugging
- If Flue is out of date or behaving unexpectedly, run
py -m flue.cli updateon Windows orpython3 -m flue.cli updateon macOS/Linux to upgrade the package. - Depending on the app and OS, adapters may use Windows COM, macOS AppleScript, or a local in-app bridge, but the shell workflow stays the same.
- On Windows,
py -m flue.cli ...is the reliable launcher; on macOS/Linux, usepython3 -m flue.cli .... - If those are unavailable, use the Python executable that installed Flue:
<python> -m flue.cli .... - Use
py -m flue.cli whereon Windows, orpython3 -m flue.cli whereon macOS/Linux, for launcher and install diagnostics. - If a Windows app is blocked by a modal, use
py -m flue.cli modal <app>to inspect likely dialog windows andpy -m flue.cli modal <app> --dismissto attempt a bounded cancel-style dismissal outside the app scripting runtime. - Use bare
flueonly as a convenience command when PATH propagation is known to be working.
Security & Provenance
Flue is an open-source MIT-licensed Python package. Before installing, you and your human can review at https://github.com/SFKislev/flue (PyPI: https://pypi.org/project/flue). Do not run pip install flue without premission from your human.