Skip to content

flowsynx/flowctl

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

FlowCtl

License: MIT Build Status FOSSA Status

The FlowCtl allows you to setup FlowSynx on your local dev machine, manage FlowSynx on local or remote instance.

Getting started

Prerequisites

On default, during initialization the flowctl will install the FlowSynx binaries as well as setup an environment to help you get started easily with FlowSynx.

Installing FlowCtl

Using script to install the latest release

Windows

Install the latest windows flowctl to $Env:SystemDrive\flowctl and add this directory to User PATH environment variable.

powershell -Command "iwr -useb https://raw.githubusercontent.com/flowsynx/flowctl/master/install/install.ps1 | iex"

Linux

Install the latest linux flowctl to /usr/local/bin

wget -q https://raw.githubusercontent.com/flowsynx/flowctl/master/install/install.sh -O - | /bin/bash

MacOS

Install the latest macOS flowctl to /usr/local/bin

curl -fsSL https://raw.githubusercontent.com/flowsynx/flowctl/master/install/install.sh | /bin/bash

From the Binary Releases

Each release of flowctl includes various OSes and architectures. These binary versions can be manually downloaded and installed.

  1. Download the flowctl
  2. Unpack it (e.g. flowsynx-linux-amd64.tar.gz, flowsynx-windows-amd64.zip)
  3. Move it to your desired location.
    • For Linux/MacOS - /usr/local/bin
    • For Windows, create a directory and add this to your System PATH. For example create a directory called c:\flowsynx and add this directory to your path, by editing your system environment variable.

Install FlowSynx as standalone mode

In standalone mode, flowsynx can be initialized using the flowctl.

Initialize FlowSynx

flowctl init

Install a specific engine version

You can install or upgrade to a specific version of the FlowSynx engine using flowctl init --flowsynx-version. You can find the list of versions in FlowSynx Release. Below a command to init specific flowsynx version

flowctl init --flowsynx-version 0.3.1

Check the versions of flowctl and flowsynx engine

flowctl version

The result will be similar to this:

{
  "FlowCtl": "0.3.3",
  "FlowSynx": "0.3.1.0",
  "Dashboard": "0.3.0.0"
}

Uninstall FlowSynx in a standalone mode

Uninstalling will remove flowsynxe binary along with the dashboard.

flowctl uninstall

The command above will remove the default flowsynx folder that was created on flowctl init.