diff --git a/README.md b/README.md index f3ab969..4e77790 100755 --- a/README.md +++ b/README.md @@ -12,6 +12,8 @@ Process compose is a lightweight utility for building custom workflows and execu It is heavily inspired by [docker-compose](https://github.com/docker/compose), but without the need for containers. The configuration syntax tries to follow the docker-compose specifications, with a few minor additions and lots of subtractions. +TUI + ### Installation - Go to the [releases](https://github.com/F1bonacc1/process-compose/releases/latest), download the package for your OS, and copy the binary to somewhere on your PATH. @@ -86,6 +88,24 @@ process2: +#### ✅ TUI (Terminal User Interface) + +##### ✅ Review processes status + +##### ✅ Start processes (only completed or disabled) + +##### ✅ Stop processes + +##### ✅ Review logs + +TUI is the default run mode, but it's possible to disable it: + +```shell +./process-compose -t=false +``` + + + #### ✅ Logger ##### ✅ Per Process Log Collection @@ -167,15 +187,19 @@ environment: - 'I_AM_GLOBAL_EV=42' ``` +Default environment variables: + +`PC_PROC_NAME` - Defines the process name as defined in the `process-compose.yaml` file. + +`PC_REPLICA_NUM` - Defines the process replica number. Useful for port collision avoidance for processes with multiple replicas. -#### ❌ System Variables -##### ❌ Process replica number +#### ✅ REST API -##### ❌ Monitoring +A convenient Swagger API is provided: http://localhost:8080/swagger/index.html -##### ❌ REST API +Swagger diff --git a/imgs/swagger.png b/imgs/swagger.png new file mode 100644 index 0000000..5781c15 Binary files /dev/null and b/imgs/swagger.png differ diff --git a/imgs/tui.png b/imgs/tui.png new file mode 100644 index 0000000..e7b30f4 Binary files /dev/null and b/imgs/tui.png differ