flow

README

flow is your personal workflow hub - organize automation across all your projects with built-in secrets, templates, and cross-project composition. Define workflows in YAML, discover them visually, and run them anywhere.

---

Quick Start

# Install
curl -sSL https://raw.githubusercontent.com/flowexec/flow/main/scripts/install.sh | bash

# Create your first workflow
flow workspace add my-project . --set
echo 'executables:
  - verb: run
    name: hello
    exec:
      cmd: echo "Hello from flow!"' > hello.flow

# Run it
flow sync
flow run hello

Key Features

flow complements existing CLI tools by adding multi-project organization, built-in security, and visual discovery to your automation toolkit.

• Workspace organization - Group and manage workflows across multiple projects
• Encrypted secret vaults - Multiple backends (AES, Age, external tools)
• Interactive discovery - Browse, search, and filter workflows visually
• Flexible execution - Serial, parallel, conditional, and interactive workflows
• Workflow generation - Create projects and workflows from reusable templates
• Composable workflows - Reference and chain workflows within and across projects

Example Workflows

# api.flow
executables:
  - verb: deploy
    name: staging
    serial:
      execs:
        - cmd: npm run build
        - cmd: docker build -t api:staging .
        - ref: shared-tools/k8s:deploy-staging
        - cmd: curl -f https://api-staging.example.com/health

  - verb: backup
    name: database
    exec:
      params:
        - secretRef: database-url
          envKey: DATABASE_URL
      cmd: pg_dump $DATABASE_URL > backup-$(date +%Y%m%d).sql

# Run workflows
flow deploy staging
flow backup database

# Visual discovery
flow browse

Documentation

Complete documentation at flowexec.io

• Installation - Multiple installation methods
• Quick Start - Get up and running in 5 minutes
• Core Concepts - Understand workspaces, executables, and vaults
• User Guides - Comprehensive guides for all features

Community

• Discord Community - Get help and share workflows
• Issue Tracker - Report bugs and request features
• Examples Repository - Real-world workflow patterns
• Contributing Guide - Help make flow better