4.7k

Reference

CLI

Manage workflows, trigger executions and pull exports from your terminal or CI pipeline.

Demo placeholderRunning fimaflow workflows list in a terminal

Why a CLI

The dashboard is built for exploring and editing a workflow by hand; the CLI is for everything you want to do without a browser open — check a workflow's status from a script, trigger a run from another tool, or export and verify a project as a step in your own pipeline before it ships. It's a thin wrapper around the same REST API the dashboard uses, so anything you can do by clicking around the builder has a command-line equivalent here.

Installing the CLI

Shell
npm install -g fimaflow

fimaflow login

fimaflow login opens a browser to authenticate, then stores a token locally the same way git or gh would.

Common commands

Shell
fimaflow workflows list
fimaflow workflows run <workflow-id>
fimaflow export <workflow-id> --target hono
fimaflow logs <workflow-id> --follow
  • workflows list — same data as the dashboard, in your terminal.
  • workflows run — trigger a run and stream the result.
  • export — pull the generated project for any supported framework without opening the builder.
  • logs --follow — tail execution logs live, useful during a deploy.

Using it in CI

Authenticate non-interactively with an API token instead of fimaflow login, and export or verify a workflow as part of your pipeline before it reaches production.

Shell
FIMAFLOW_TOKEN=$CI_FIMAFLOW_TOKEN fimaflow export <workflow-id> --target hono --out ./backend

Interactions with the rest of the platform

  • • Reach for the SDK instead of shelling out to the CLI from application code — same underlying API, but typed and without spawning a subprocess.
  • fimaflow export produces the exact same project as exporting from the builder — see Framework Export for what's generated.

Limitations

  • workflows run streams the result of a single execution — it doesn't poll or retry on its own; wrap it in your own loop if a CI step needs that.
  • • The CLI can trigger and inspect workflows, but it can't edit a workflow's nodes or connections — that's builder-only, by design.

Next steps

CLI | Fimaflow