Command-line interface for TheFluxTrain APIs
Project description
thefluxtrain-cli
Command-line interface for TheFluxTrain APIs.
Install
pip install thefluxtrain-cli
# or
uv tool install thefluxtrain-cli
Commands
tft login # Device-code sign-in via thefluxtrain.com
tft logout # Clear local credentials and local CLI data
tft sync # Refresh the CLI command list
tft whoami # Show signed-in email
tft commands # List all available API commands
tft media info # Get video, audio, or image metadata via the API
tft jobs wait # Poll until an async generation job completes
Quick start
tft login
tft commands
tft whoami
Output format
Manifest commands print compact single-line JSON by default:
tft files upload --file ./photo.png --fields data.url
tft flow-studio create --name "My flow" --fields data.flow_id
tft video-editor get --project-id PID --output pretty
| Flag | Effect |
|---|---|
--output json (default) |
Compact single-line JSON |
--output pretty |
Indented JSON |
--output yaml |
YAML |
--fields data.url |
Plain value(s), comma-separated for multiple paths |
API failures print a JSON envelope to stdout (data: null, error: { code, message }) with exit code 1.
For --actions JSON (flow-studio apply, video-editor apply-*), pass inline JSON, @path/to/file.json, or - for stdin.
Async jobs: tft jobs wait --editor-id JOB_ID (or poll with tft jobs check-status).
How login works
tft loginrequests a device code from the API.- Open https://thefluxtrain.com/cli/authorize and sign in if needed.
- Enter the code from your terminal and click Authorize CLI.
- The CLI stores an API key in
~/.config/thefluxtrain/credentials.json. - The CLI command list is refreshed automatically after login.
Command list refresh
The CLI keeps its command list and help text up to date automatically. Run tft sync to refresh manually, then use tft commands and tft <group> <command> --help to discover what is available.
Media metadata
Probing runs on the render service (MoviePy + ffmpeg):
tft media info --file ./clip.mp4
tft media info --url UPLOAD_URL --fields data.duration
Optional env var: THEFLUXTRAIN_RENDER_API (default https://render.thefluxtrain.com, same as frontend VITE_RENDER_API).
Use data.duration for audio clips; use data.width, data.height, and data.duration for video/image createAsset apply actions after tft files upload.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file thefluxtrain_cli-0.1.31.tar.gz.
File metadata
- Download URL: thefluxtrain_cli-0.1.31.tar.gz
- Upload date:
- Size: 19.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.11.26 {"installer":{"name":"uv","version":"0.11.26","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c2e1fbda5e036a74fcb1c087ebc4adb34dec0bb67b4b22b0b4092197aba781a3
|
|
| MD5 |
e5cec55846f8c3c8fb369afcf35fd565
|
|
| BLAKE2b-256 |
4676eff4e47488ac6aac448a4640d25048f32ce69951e60ecb0090f31221406e
|
File details
Details for the file thefluxtrain_cli-0.1.31-py3-none-any.whl.
File metadata
- Download URL: thefluxtrain_cli-0.1.31-py3-none-any.whl
- Upload date:
- Size: 18.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.11.26 {"installer":{"name":"uv","version":"0.11.26","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8d8ec12a9b17fa2a4459f949536e803c6a31d7cf06eea82526a517a8ff751769
|
|
| MD5 |
c6ff3aca5698b9853d0760d3c84370dd
|
|
| BLAKE2b-256 |
b7451a8e1f668f8db6be205bc1ed0298f605dec4dfd7d51d17fa06ece99bcb90
|