Skip to content

Commit 7d73b49

Browse files
committed
Update README to include screenshot
#120
1 parent c8ca8b8 commit 7d73b49

2 files changed

Lines changed: 28 additions & 27 deletions

File tree

README.md

Lines changed: 28 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,35 @@
1-
# FlowCtl
2-
3-
[![dotnet][dotnet-budge]][dotnet-url] [![License: MIT][mit-badge]][mit-url] [![Build Status][actions-badge]][actions-url] [![FOSSA Status][fossa-badge]][fossa-url]
4-
5-
[mit-badge]: https://img.shields.io/github/license/flowsynx/flowctl?style=flat&label=License&logo=github
6-
[mit-url]: https://github.com/flowsynx/flowctl/blob/master/LICENSE
7-
[actions-badge]: https://github.com/flowsynx/flowctl/actions/workflows/flowctl-release.yml/badge.svg?branch=master
8-
[actions-url]: https://github.com/flowsynx/flowctl/actions?workflow=flowctl
9-
[fossa-badge]: https://app.fossa.com/api/projects/git%2Bgithub.com%2Fflowsynx%2Fcli.svg?type=shield&issueType=license
10-
[fossa-url]: https://app.fossa.com/projects/git%2Bgithub.com%2Fflowsynx%2Fcli?ref=badge_shield&issueType=license
11-
[dotnet-budge]: https://img.shields.io/badge/.NET-9.0-blue
12-
[dotnet-url]: https://dotnet.microsoft.com/en-us/download/dotnet/9.0
1+
<div align="center">
2+
<h2>FlowCtl</h2>
3+
<p><i>Command-line tools for control FlowSynx</i></p>
4+
5+
[![dotnet][dotnet-budge]][dotnet-url] [![License: MIT][mit-badge]][mit-url] [![Build Status][actions-badge]][actions-url] [![FOSSA Status][fossa-badge]][fossa-url]
6+
7+
[mit-badge]: https://img.shields.io/github/license/flowsynx/flowctl?style=flat&label=License&logo=github
8+
[mit-url]: https://github.com/flowsynx/flowctl/blob/master/LICENSE
9+
[actions-badge]: https://github.com/flowsynx/flowctl/actions/workflows/flowctl-release.yml/badge.svg?branch=master
10+
[actions-url]: https://github.com/flowsynx/flowctl/actions?workflow=flowctl
11+
[fossa-badge]: https://app.fossa.com/api/projects/git%2Bgithub.com%2Fflowsynx%2Fcli.svg?type=shield&issueType=license
12+
[fossa-url]: https://app.fossa.com/projects/git%2Bgithub.com%2Fflowsynx%2Fcli?ref=badge_shield&issueType=license
13+
[dotnet-budge]: https://img.shields.io/badge/.NET-9.0-blue
14+
[dotnet-url]: https://dotnet.microsoft.com/en-us/download/dotnet/9.0
15+
</div>
1316

1417
**flowctl** is a powerful command-line interface (CLI) tool written in C# for controlling and managing a FlowSynx workflow automation system.
1518
Designed for developers and operations teams, flowctl enables seamless integration, orchestration, and lifecycle management of workflows
1619
whether you're working in the cloud, on-premises, or in hybrid environments.
1720

18-
---
21+
![Flowctl CLI Screenshot](/img/flowctl.jpg)
1922

20-
## Features
23+
## Features
2124
- 🔧 **Workflow Lifecycle Management**: Create, update, validate, delete, and execute workflows.
2225
- 📦 **Plugin Support**: Manage plugins and integrations for workflow tasks.
2326
- 📊 **Monitoring & Status**: Query real-time execution status and audit logs.
2427
- 🔐 **Authentication**: Supports Basic and JWT tokens-based authentication.
2528
-**Cross-Platform**: Runs on Windows, Linux, and macOS (.NET 9+ required).
2629

27-
---
28-
29-
## 📦 Installation
30+
## Installation
3031

31-
### 🛠️ Building FlowCtl from Source
32+
### Building FlowCtl from Source
3233
To build FlowCtl from source, ensure you have the .NET 9 SDK installed and configured in your environment. Then follow the steps below:
3334
```
3435
git clone https://github.com/flowsynx/flowctl.git
@@ -37,7 +38,7 @@ dotnet build -c Release
3738
```
3839
The compiled binaries will be located in the bin/Release/net9.0 directory.
3940

40-
#### (Optional) Add FlowCtl to Your System PATH
41+
#### (Optional) Add FlowCtl to Your System PATH
4142
To make flowctl available globally from any terminal session:
4243
- Linux/macOS:
4344
```
@@ -53,12 +54,12 @@ After setting the PATH, you can verify the installation with:
5354
```
5455
flowctl --version
5556
```
56-
> Building from source is recommended for contributors or developers customizing FlowCtl for internal use.
57+
> Building from source is recommended for contributors or developers customizing FlowCtl for internal use.
5758
58-
### 🚀 Installing FlowCtl
59+
### Installing FlowCtl
5960
You can install FlowCtl, the CLI for FlowSynx workflow automation system, using a platform-specific script or by downloading binaries manually from the Releases page.
6061

61-
#### 🪟 Windows
62+
#### Windows
6263
Use the following PowerShell script to install FlowCtl to $Env:SystemDrive\flowctl and automatically add this directory to your User PATH:
6364

6465
```
@@ -67,7 +68,7 @@ powershell -Command "iwr -useb https://raw.githubusercontent.com/flowsynx/flowct
6768

6869
After installation, restart your terminal or run refreshenv (if using tools like Chocolatey) to ensure FlowCtl is available in your PATH.
6970

70-
#### 🐧 Linux
71+
#### Linux
7172
Install FlowCtl to `/usr/local/bin`, making it accessible system-wide:
7273

7374
```
@@ -76,7 +77,7 @@ wget -q https://raw.githubusercontent.com/flowsynx/flowctl/master/install/instal
7677

7778
This script automatically detects your architecture and places the flowctl binary in `/usr/local/bin`.
7879

79-
#### 🍎 macOS
80+
#### macOS
8081
Install FlowCtl to /usr/local/bin using curl:
8182

8283
```
@@ -88,7 +89,7 @@ Ensure `/usr/local/bin` is in your shell's PATH. You can check this by running:
8889
echo $PATH
8990
```
9091

91-
#### 📦 Manual Installation from Binary Releases
92+
#### Manual Installation from Binary Releases
9293
If you prefer not to use the install scripts, you can manually download and set up FlowCtl:
9394

9495
1. Visit the [Releases page](https://github.com/flowsynx/flowctl/releases).
@@ -110,7 +111,7 @@ If you prefer not to use the install scripts, you can manually download and set
110111
flowctl --version
111112
```
112113

113-
### 🧰 Initialize FlowSynx in Standalone Mode
114+
### Initialize FlowSynx in Standalone Mode
114115
In standalone mode, FlowSynx can operate locally with minimal dependencies. You can initialize FlowSynx using FlowCtl with a simple command:
115116
```
116117
flowctl init
@@ -147,7 +148,7 @@ This will output version information in JSON format, similar to the example belo
147148

148149
> This command is useful for confirming compatibility and ensuring you're using the intended versions.
149150
150-
### 🔄 Uninstalling FlowSynx (Standalone Mode)
151+
### Uninstalling FlowSynx (Standalone Mode)
151152
To uninstall FlowSynx in standalone mode, run the following command:
152153
```
153154
flowctl uninstall

img/flowctl.jpg

116 KB
Loading

0 commit comments

Comments
 (0)