flow

README

flow - One CLI to manage all your development workflows and systems

[](

Getting Started

Installation

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

Setting up a Workspace

A Workspace is a directory that contains workflows and configuration files for flow to manage. A workspace can be created anywhere on your system but must be registered in the User Config file in order to have executables discovered by flow.

To create a new workspace:

flow init workspace <name> <path>

This command will register the Workspace and create the root config file for you. For more information on Workspaces and it's config, see Workspaces.

Defining Executables

Executables are the core of flow. They are the workflows that flow will execute when running a workflow. Each executable is driven by its definition within an executable definition file (*.flow file). There are several types of executables that can be defined. For more information on Executables and it's config, see Executables.

Running and managing workflows

The main command for running workflows is flow exec. This command will execute the workflow with the provided executable ID. exec can be replaced with any verb but should match the verb defined in the executable's definition or an alias of the verb.

As you make changes to executables on your system, you can run flow sync to trigger a re-index of your executables.

See flow CLI documentation for more information on all available commands.

Autocompletion

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