flow

README

flow - Local, CLI Workflow Manager

Configuration and Workflow Definition Files

flow uses a configuration file to define the workspaces and workflows that it manages. The location for this flow configuration file is ~/.flow/config.yaml. Below is an example of a flow configuration file.

currentWorkspace: workspace1
workspaces:
  workspace1: /path/to/workspace1
  workspace2: /path/to/workspace2

Workflows can be defined anywhere within a workspace's directory with the .flow file extension. Below is an example of a workflow definition file.

namespace: ns
tags:
  - example
executables:
  - type: open
    name: config
    tags:
      - config
    description: open flow config in vscode
    spec:
      uri: .flow
      application: Visual Studio Code

Running flow open ns:config will run the above workflow.

CLI Usage

flow [command]

Available Commands

Updating configs and data used by flow

• flow get - Get current value of various configuration options and data
• flow set - Update various configuration options and data
• flow create - Create ...
• flow delete - Delete ...
• flow vault - Manage secrets stored in the vault

Executing workflows

• flow run - Run a workflow
• flow open - Open a workflow in the browser

Autocompletion

• flow completion - Generate shell autocompletion for flow

Example autocompletion setup script: flow completion zsh > ~/.oh-my-zsh/completions/_flow

Install

You can install the pre-compiled binary or compile from source.

via Go Install

go install github.com/jahvon/flow@latest

via GitHub Releases

Download the pre-compiled binaries from the release page page and copy them to the desired location.

$ VERSION=v1.0.0
$ OS=Linux
$ ARCH=x86_64
$ TAR_FILE=flow_${OS}_${ARCH}.tar.gz
$ wget https://github.com/jahvon/flow/releases/download/${VERSION}/${TAR_FILE}
$ sudo tar xvf ${TAR_FILE} flow -C /usr/local/bin
$ rm -f ${TAR_FILE}

via Source

$ git clone github.com/jahvon/flow
$ cd flow
$ go generate ./...
$ go install