flowctl

command module
v0.1.0-alpha.1 Latest Latest
Warning

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

Go to latest
Published: Nov 20, 2025 License: Apache-2.0 Imports: 2 Imported by: 0

README


An open-source self-service workflow execution platform

Features

  • Workflows - Define complex workflows using simple YAML/HUML configuration with inputs, actions, and approvals
  • SSO - Secure authentication using OIDC
  • Approvals - Add approvals to sensitive operations
  • Teams - Organize workflows by teams or projects with isolated namespaces and built-in RBAC
  • Remote Execution - Execute workflows on remote nodes via SSH
  • Secure Secrets - Store SSH keys, passwords, and secrets securely with encrypted storage
  • Real-time Logs - Track workflow executions with streaming logs
  • Scheduling - Automate workflows with cron-based scheduling

Quick Start

Prerequisites

  • PostgreSQL database
  • Docker

Installation

Docker

Use the provided docker-compose.yml file.


Binary
  1. Download the latest binary from releases

  2. Generate configuration:

    ./flowctl --new-config
    
  3. Database migrations:

    ./flowctl install
    
  4. Start the server and visit http://localhost:7000:

    ./flowctl install
    

Example Workflow

metadata:
  id: hello_world
  name: Hello World
  description: A simple greeting flow

inputs:
  - name: email
    type: string
    label: Email
    validation: email matches "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\\\.[a-zA-Z]{2,}$"
    required: true

actions:
  - id: greet
    name: Greet User
    executor: docker
    variables:
      - username: "{{ inputs.email }}"
    with:
      image: docker.io/alpine
      script: |
        echo "Hello, $username!"

Documentation

Full documentation is available at flowctl.net

Contributing

Contributions are welcome! Please open an issue or submit a pull request.

License

flowctl is licensed under the Apache 2.0 license.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
executors
internal
remoteclients
ssh
sdk

Jump to

Keyboard shortcuts

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