Reference

CLI

Browse workflows, trigger runs, tail logs and pull exports from your terminal or CI pipeline — plus a full-screen interactive mode.

bash

❯ fimaflow login
Opening https://www.fimaflow.com/cli/authorize?callback=…
Logged in as you@company.com (profile: default)
 
❯ fimaflow workflows list
ID                                    NAME                       SLUG
4de8462d-a9a4-44d6-bd2f-9be429b9139f  Build your first REST API  build-your-first-rest-api
f8f744ce-2093-4b4e-bb13-44ec41d6e86d  Checkout webhook           checkout-webhook
 
❯ fimaflow run 4de8462d --follow
[apiEndpoint] API Endpoint — Flow 1
[response]   Response 200
[████████████████████████]  2/2  ✓ done

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 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. It can trigger and inspect anything, but it never edits a workflow's nodes or connections — that stays in the builder, by design.

Installing the CLI

Standalone binary — no Bun or Node required, macOS/Linux (arm64 + x64) and Windows (x64):

bash

❯ curl -fsSL https://raw.githubusercontent.com/Nathan-Josue/Fimaflow-cli/main/scripts/install.sh | sh
 
❯ fimaflow login

Or via npm or pnpm — either way the CLI itself still runs on Bun, not Node, so make sure it's installed:

bash

❯ npm install -g fimaflow
# or
❯ pnpm install -g fimaflow
 
❯ fimaflow login

fimaflow login opens a browser to authorize the CLI on your account, runs a short-lived local server to catch the token, and stores it under ~/.config/fimaflow/ — the same way gh auth login works. Credentials live in their own file with 0600 permissions, never in a shared config.

Authentication

For CI or a headless box where no browser is available, skip fimaflow login and pass a token instead. Create one from the dashboard, then:

bash

# interactive: paste a token
❯ fimaflow login --token <token>
 
# non-interactive: an env var, nothing stored on disk
❯ FIMAFLOW_TOKEN=<token> fimaflow whoami

• FIMAFLOW_TOKEN overrides any saved or profile token — use it in CI.
• FIMAFLOW_API_URL points the CLI at a different backend.
• --profile <name> (or FIMAFLOW_PROFILE) keeps separate accounts side by side.
• fimaflow whoami confirms who you're signed in as; fimaflow logout clears the stored token.

Commands

Workflows, runs & logs

bash

❯ fimaflow workflows list
❯ fimaflow workflows get <workflow-id>
 
❯ fimaflow run <workflow-id> --follow        # stream logs node by node
❯ fimaflow run <workflow-id> --detach        # just print the execution id
❯ fimaflow logs <workflow-id> --follow       # tail the latest execution
❯ fimaflow logs <workflow-id> --execution <id> --follow
❯ fimaflow executions <workflow-id>

--follow streams the same live events the builder shows, with a progress bar for nodes completed. It follows one execution and exits — wrap it in your own loop if a CI step needs polling or retries.

Export

bash

❯ fimaflow export <workflow-id> --target hono --out ./backend

Targets: hono, fastify, express, elysia, fastapi. Produces the exact same project as exporting from the builder — see Framework Export.

Projects, workspaces & templates

bash

❯ fimaflow projects list
❯ fimaflow projects create --name "Payments API"
❯ fimaflow projects add-workflow <project-id> <workflow-id>
❯ fimaflow projects remove-workflow <project-id> <workflow-id>
 
❯ fimaflow workspaces list
❯ fimaflow workspaces members <workspace-id>
❯ fimaflow workspaces switch <workspace-id>
 
❯ fimaflow templates list
❯ fimaflow templates import <slug>
❯ fimaflow templates publish <workflow-id> --category "API"

Every command takes --json for machine-readable output, and every one returns a stable exit code (0 ok, 1 the run failed, 2 missing config, 3 not authenticated, 4 not found).

Interactive mode

bash

❯ fimaflow tui

A full-screen dashboard: tabs for Workflows, Projects, Workspaces and Templates (1–4 or Tab), j/k or arrows to move, / to filter. From the Workflows tab, Enter runs the selection and streams its logs inline; x shows its execution history. q steps back or quits.

Using it in CI

Authenticate with FIMAFLOW_TOKEN, and export a workflow as part of your pipeline before it reaches production. Non-TTY output drops the colors and progress bars automatically.

bash

❯ FIMAFLOW_TOKEN=$CI_FIMAFLOW_TOKEN \
  fimaflow export $WORKFLOW_ID --target hono --out ./backend

Limitations

• The CLI triggers and inspects workflows — it can't edit nodes or connections. That's builder-only.
• run / logs --follow stream a single execution and exit; they don't poll or retry on their own.
• GitHub publishing, version restore and the DB explorer aren't exposed on the CLI yet — use the dashboard for those.

Next steps

Deployment Overview

Where an exported project goes next.

Framework Export

What `fimaflow export` generates.