FLX

A fast and extensible automation flow engine.

What is FLX?

Pronounced "flex".

FLX is a fast and extensible automation flow engine. It's designed to be easy to use, with a basic syntax similar to GitHub Workflows. You can automate your common tasks with FLX without long scripts.

Features

• YAML-based flow definitions.
• Simple syntax inspired by GitHub Workflows.
• Extensible step types.
• Flows, jobs, steps, and triggers.
• Fast execution.
• Type-safe with TypeScript.

Why FLX?

FLX is designed to be easy to use, with a basic syntax similar to GitHub Workflows. You can automate your common tasks with FLX without long scripts. Long tasks you repeat often can be automated with FLX, and you can automate long tasks you don't repeat often with GitHub Actions.

Installation

Requires Node.js >= 20.

npm install -g flx-flow

Usage

Create a flow file and run it:

flx run path/to/flow.yml

Example flow

name: Flow Example

triggers:
    manual:
        with: {}

tasks:
    start:
        steps:
            - print: Hello from FLX!

            - run: bun run test

Step actions

| Action | Description | | ------- | --------------------------------- | | run | Execute the command in a shell. | | print | Print the message to the console. | | ask | Ask the value for a named input. |

Development

bun install
bun run dev -- run path/to/flow.yml
bun test