flow

command module
v1.1.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 26, 2025 License: Apache-2.0 Imports: 12 Imported by: 0

README

flow

GitHub release Go Reference Join Discord GitHub Repo stars

flow is your local-first developer platform - organize automation across all your projects with built-in secrets, templates, and cross-project workflows. Define workflows in YAML, browse auto-generated documentation, 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, keyring, 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
  • Platform integrations - GitHub Actions, AI assistants (MCP), and more

flow

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

Community

Documentation

The Go Gopher

There is no documentation for this package.

Source Files

Directories

Path Synopsis
cmd
Package cmd handle the cli commands
Package cmd handle the cli commands
internal
internal/flags
internal/version
internal
fileparser
io
io/cache
io/common
io/config
io/executable
io/library
io/logs
io/secret
io/vault
io/workspace
mcp
mcp/mocks
Package mocks is a generated GoMock package.
Package mocks is a generated GoMock package.
runner
runner/engine
runner/engine/mocks
Package mocks is a generated GoMock package.
Package mocks is a generated GoMock package.
runner/engine/retry
runner/exec
runner/launch
runner/mocks
Package mocks is a generated GoMock package.
Package mocks is a generated GoMock package.
runner/parallel
runner/render
runner/request
runner/serial
services/git
services/open
services/rest
services/run
services/store
services/store/mocks
Package mocks is a generated GoMock package.
Package mocks is a generated GoMock package.
templates
utils
utils/env
utils/executables
vault
pkg
cache
cache/mocks
Package mocks is a generated GoMock package.
Package mocks is a generated GoMock package.
cli
Package cli provides a public API for extending and customizing the Flow CLI.
Package cli provides a public API for extending and customizing the Flow CLI.
cli/example command
Package main demonstrates basic usage of the Flow CLI extension API.
Package main demonstrates basic usage of the Flow CLI extension API.
context
errors
filesystem
logger
tests
utils
utils/builder
tools
docsgen command
docsgen/schema
types
common
config
executable
workspace

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL