Metadata-Version: 2.4
Name: vrex-flow-engine
Version: 0.2.3
Summary: Launcher + supervisor and OpenAI-compatible image/video generation service (Vrex Flow Engine).
Author: Vrex
License: Proprietary
Project-URL: Homepage, https://getvrex.com
Keywords: vrex,flow-engine,cli,supervisor,image-generation,video-generation
Classifier: Programming Language :: Python :: 3
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Operating System :: POSIX
Classifier: Topic :: Multimedia :: Video
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: fastapi>=0.110
Requires-Dist: uvicorn[standard]>=0.27
Requires-Dist: httpx>=0.27
Requires-Dist: websockets>=12.0
Requires-Dist: pydantic>=2.5
Requires-Dist: python-multipart>=0.0.9
Requires-Dist: posthog>=3.8
Requires-Dist: rich>=13.7

# vrex-flow-engine

One-command launcher + supervisor for the **Vrex Flow Engine** — a self-hosted
service that exposes OpenAI-compatible image/video generation endpoints.

`vrex-flow-engine start` stores your engine key + Cloudflare tunnel token,
launches the engine and the tunnel as supervised child processes (with
crash-restart), and renders a live status dashboard.

## Quickstart

```bash
uvx vrex-flow-engine start
```

`uvx` ships with [uv](https://docs.astral.sh/uv/). If you get
`uvx: command not found`, install uv (`curl -LsSf https://astral.sh/uv/install.sh | sh`,
or `brew install uv`) and re-run. No uv? `pipx run vrex-flow-engine start`, or
`pip install --user vrex-flow-engine && flow-engine start`.

First run prompts for the engine API key and the Cloudflare tunnel token (saved
to `~/.vrex-flow/config.json`, chmod 600), then brings up the engine + tunnel.
Ctrl-C stops both cleanly.

## Commands

| Command | What it does |
|---|---|
| `vrex-flow-engine start` | Run engine + tunnel with a live dashboard. `--no-tunnel` runs the engine only; `--tunnel-config <path>` drives an existing cloudflared config.yml (named tunnel) instead of a token. |
| `vrex-flow-engine setup` | Store the engine key + tunnel token. |
| `vrex-flow-engine doctor` | Check prerequisites and probe a running engine. |
| `vrex-flow-engine serve` | Run just the engine in the foreground. |

The short alias `flow-engine` is installed for the same commands.

## Requirements

- Python 3.10+
- [`cloudflared`](https://developers.cloudflare.com/cloudflare-one/connections/connect-networks/downloads/)
  (for the tunnel; `--no-tunnel` skips it)
- Access to a Vrex Flow Engine deployment.

Internal Vrex tooling.
