FLOW MASON

Getting Started

Install FlowMason and create your first AI pipeline in under 5 minutes.

Prerequisites

Before you begin, make sure you have:

  • Python 3.11+ installed
  • VSCode (recommended) or another code editor
  • pip package manager

Installation

Install FlowMason using pip:

pip install flowmason

Verify the installation:

fm --version
# flowmason 0.7.3

VSCode Extension

For the best development experience, install the FlowMason VSCode extension:

  1. Open VSCode
  2. Go to Extensions (Cmd+Shift+X)
  3. Search for “FlowMason”
  4. Click Install

Or install from the command line:

code --install-extension flowmason.flowmason

Create Your First Project

Initialize a new FlowMason project:

fm init my-project
cd my-project

This creates a project structure:

my-project/
├── flowmason.json          # Project configuration
├── components/             # Custom components
│   ├── nodes/             # AI-powered nodes
│   └── operators/         # Utility operators
├── pipelines/             # Pipeline definitions
│   └── main.pipeline.json # Sample pipeline
└── tests/                 # Pipeline tests

Start the Studio

FlowMason Studio is the backend service that powers pipeline execution and debugging:

fm studio start

You should see:

FlowMason Studio starting...
✓ API server running at http://localhost:8999
✓ WebSocket server ready
✓ Database initialized

Run Your First Pipeline

Execute the sample pipeline:

fm run pipelines/main.pipeline.json

Or press F5 in VSCode with a pipeline file open.

Next Steps