Skip to main content

Grida FX in the Grida CLI

grida fx plans and runs reusable asset workflows. FX reuses cached results and records each run for inspection.

Run a workflow​

grida fx --help
grida fx plan workflow.yaml
grida fx run workflow.yaml --live --max-usd 2

Each grida release carries the Grida FX version it pins, so updating grida updates FX. grida fx --version prints that version. FX owns these commands, their options and their help: grida fx <command> --help describes each one. The FX guide covers workflow files, nodes, costs, caching and runs.

Generate one image​

For a single PNG, you can call image.generate directly. This example previews a request using the project's configured image route.

grida fx call image.generate --prompt 'A red kite above a foggy hill' --dry-run

To generate, replace --dry-run with --live. Metered routes use --max-usd or the project budget. See grida fx call image.generate --help for route and output options.

Platforms​

FX runs on macOS and on Linux with glibc 2.28 or later. On Windows, use WSL 2; on Alpine and other musl systems, use a glibc-based image. Elsewhere, grida fx exits with status 1 and explains this. The other grida commands are unaffected.

Provider keys​

FX checks the environment, then the project's .env. On macOS and Linux, eligible providers can also use a key saved with grida ai providers configure. Use grida fx doctor to check your setup. Configure provider keys

FX on its own​

The JavaScript SDK is @grida/fx (npm install @grida/fx), which also installs a standalone grida-fx command. The Python SDK is pip install grida, run as python -m grida.fx. All three run the same engine, and what they print and record is the same apart from the command name they show.