diff --git a/README.md b/README.md index 598cb4d..32799ab 100644 --- a/README.md +++ b/README.md @@ -3,10 +3,39 @@ ## description Go Manager is a program that watches your package binaries and if they're not the same version of your installed go version, it rebuilds the packages. +By default it is ran every 24 hours. +It does not use fnotify or similar. +It's a simple tool which checks the current Go version vs the version of the complied binaries. -all commands **must** be ran as root +You **MUST** be root to run all commands + +## scenario + +You have go projects which you `git clone` and `go build`. +You can't be arsed to keep the built binaries up to date, manually, every time a new Go version is released. +Gomanager does this job for you, periodically. ## install + +### pre-requisites +a functioning build environment + +#### CentOS/RHEL/Rocky/Alma etc +```bash +yum groupinstall 'Development Tools' +``` + +#### Debian/Ubuntu +```bash +apt install build-essentials +``` + +#### Archlinux +```bash +pacman -S base-devel +``` + +### Default installation procedure ```bash CGO_ENABLED=1 go install code.icod.de/dalu/gomanager@latest mv ~/go/bin/gomanager /usr/local/bin/ @@ -20,12 +49,23 @@ gomanager add \ --root-path="" \ --binary-path="" \ --service-name="" \ - ``` ### remove project +Find out the ID of a watched project with `gomanager list` ```bash -gomanager remove +gomanager remove --id 1 +``` + +### list projects +```bash +gomanager list +``` + +### show logs of a project +Find out the ID of a watched project with `gomanager list` +```bash +gomanager logs --id 1 ``` ### start/run