Skip to content

Create a Flow ​

Purpose ​

Compose published BioLine Tool versions into a reusable directed acyclic workflow. A single-node workflow follows the same process. The Flow JSON must provide a non-empty desc; it is written as the user-visible Flow description. For backward compatibility, fkit falls back to method.purpose when desc is omitted.

Syntax ​

bash
fkit flow create [OPTIONS] --file <FILE> <FLOW_NAME>

Agent workflow ​

For a request to create or compose a workflow:

  1. Read fkit tool list --json once and resolve exact Tool versions; use the latest version when omitted.
  2. If a requested Tool is missing, read fkit create-tool --docs and follow the Tool-creation plan to verify its image, command, parameters, and endpoints, then create, configure, and read back the missing Tool. Refresh the Tool list afterward; never guess a version or skip configuration. Tool creation and Flow publication have separate confirmation points.
  3. Export each existing or newly created Tool configuration and summary. Configuration is the only authority for ports, types, patterns, and parameters.
  4. Validate port names, types, patterns, parameters, and connections. file and file_group may connect; folder connects only to folder.
  5. Check semantic order and DAG structure; never guess ports or parameters.
  6. Write a graph containing a non-empty desc, nodes, and connections, plus the required method evidence, and write the bilingual summary.
  7. Show one concise plan and wait for confirmation; invoke fkit flow create only after confirmation.
  8. Read back the created version with fkit flow inspect and verify ports and connections.

When Tools are missing, explain which Tools must be created and show their Tool-creation plan first. After the user confirms, finish Tool creation before showing the final Flow plan and asking for Flow publication confirmation. If any Tool creation fails, stop and do not publish an incomplete Flow.

Unconnected inputs and outputs become external workflow ports. Keep at least one external input and one external output. Each input has at most one source; outputs may fan out. I/O ports must not be placed in node params.

File requirements ​

The graph must use exact TOOL:positive-integer references, unique node IDs, and a DAG. desc is the user-visible Flow description and must state the purpose, main nodes, and key outputs. method records the purpose, topological ordered_steps, and at least one official or literature source; it is used for validation and is not sent as an undefined backend graph field.

Confirmation ​

Show only the tools, order, connections, external ports, parameters, rationale, and user-facing risks. Do not show raw commands, CLI output, workspace paths, or debugging. After confirmation, create and read back the Flow without another confirmation.

Arguments and options ​

  • --file <FILE> — required Flow graph JSON.
  • --dry-run — validate and preview without creating a remote Flow.

Effect ​

A normal invocation creates a new Flow version in BioLine; --dry-run does not write remotely.

Output ​

Success returns the Flow name, ID, and version. Read back with flow inspect after creation.

Read this page ​

Use --docs to read this page from BioLine's official AI documentation; --docs-json returns the JSON wrapper.