Main Flow Structure (main.phlow)

The main.phlow file defines the flow's metadata and execution logic. By default, main.phlow is the primary file executed in Phlow, serving as the entry point for defining workflows and their associated configurations.

Structure

Field	Description
	main
name	A user-friendly name for the flow.
version	The flow's semantic version.
description	A brief summary of the flow's purpose.
	modules
steps	The sequence of steps the flow will execute.

Example

main: cli
name: Are you a student?
version: 1.0.0
description: Check if you are a student.
author: Your Name
modules: !include modules.yaml
steps:
  # Flow execution steps

Custom Fields

It is possible to add custom fields to the main.phlow file to better suit your workflow's needs. For example, you can include fields like tags to categorize your flow or author to specify the creator of the flow.

These fields can help improve the organization and documentation of your workflows.

Example with custom fields:

main: cli
name: Are you a student?
version: 1.0.0
description: Check if you are a student.
author: Your Name
tags:
    - education
    - student
modules: !include modules.yaml
steps:
    # Flow execution steps

Simple Flows Without Main Module

Phlow also supports simple flows that don't require a main module. These flows execute steps directly without waiting for external input:

name: Simple Greeting
version: 1.0.0
description: A simple greeting flow.
steps:
  - payload:
      message: "Hello, World!"
  - payload: !phs `Final result: ${ payload.message }`

This approach is useful for:

• Batch processing
• Data transformation
• Simple automation tasks
• Testing and prototyping