{"id":19196137,"url":"https://github.com/cirello-io/runner","last_synced_at":"2025-05-09T00:33:49.807Z","repository":{"id":51139181,"uuid":"140161314","full_name":"cirello-io/runner","owner":"cirello-io","description":"Runner is a structured command executer that monitor file changes to trigger process restarts.","archived":false,"fork":false,"pushed_at":"2025-05-06T20:27:31.000Z","size":1540,"stargazers_count":16,"open_issues_count":0,"forks_count":4,"subscribers_count":1,"default_branch":"v3","last_synced_at":"2025-05-06T21:33:04.081Z","etag":null,"topics":["orchestrator","procfile","runner"],"latest_commit_sha":null,"homepage":"https://pkg.go.dev/cirello.io/runner/v3","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cirello-io.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2018-07-08T11:21:32.000Z","updated_at":"2025-05-06T20:27:28.000Z","dependencies_parsed_at":"2022-09-06T12:20:37.213Z","dependency_job_id":"4f806cc4-1507-4ff3-a71f-fd95d69af7a4","html_url":"https://github.com/cirello-io/runner","commit_stats":null,"previous_names":["ucirello/runner"],"tags_count":50,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cirello-io%2Frunner","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cirello-io%2Frunner/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cirello-io%2Frunner/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cirello-io%2Frunner/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cirello-io","download_url":"https://codeload.github.com/cirello-io/runner/tar.gz/refs/heads/v3","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253171166,"owners_count":21865275,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["orchestrator","procfile","runner"],"created_at":"2024-11-09T12:12:45.606Z","updated_at":"2025-05-09T00:33:49.776Z","avatar_url":"https://github.com/cirello-io.png","language":"Go","readme":"# Runner\n\n[![GoDoc](https://pkg.go.dev/badge/cirello.io/runner/v3)](https://pkg.go.dev/cirello.io/runner/v3)\n[![License](https://img.shields.io/badge/license-apache%202.0-blue.svg)](https://choosealicense.com/licenses/apache-2.0/)\n\nrunner is a structured command executer for Unix systems that monitor file\nchanges to trigger process restarts.\n\nCreate a file name Procfile in the root of the project you want to run, and add\nthe following content:\n\n\tworkdir: $GOPATH/src/github.com/example/go-app\n\tformation: web web-a web-b db optional-service=0\n\tobserve: *.go *.js\n\tignore: /vendor\n\tbuild-server: make server\n\tweb: restart=fail waitfor=localhost:8888 ./server serve\n\tweb-a: restart=onbuild waitfor=localhost:8888 ./server serve alpha\n\tweb-b: restart=onbuild waitfor=localhost:8888 ./server serve bravo\n\tdb: restart=failure waitfor=web ./server db\n\toptional-service: ./optional-service\n\nSpecial process type names:\n\n- workdir: the working directory. Environment variables are expanded. It follows\nthe same rules for exec.Command.Dir.\n\n- observe: a space separated list of file patterns to scan for. It uses\nfilepath.Match internally. File patterns preceded with exclamation mark (!) will\nnot trigger builds.\n\n- ignore: a space separated list of ignored directories relative to workdir,\ntypically vendor directories.\n\n- formation: allows to control how many instances of a process type are\nstarted, format: procTypeA:# procTypeB:# ... procTypeN:#. If `procType` is\nabsent, it is not started. Empty formations start one of each process.\n\n- build*: process type name prefixed by \"build\" are always executed first and in\norder of declaration. On failure, they halt the initialization.\n\n- waitfor (in process type): target hostname and port that the runner will probe\nbefore starting the process type.\n\n- restart (in process type): \"onbuild\" will restart the process type at every\nbuild; \"fail\" will restart the process type on failure; \"loop\" restart the\nprocess when it naturally terminates; \"temporary\" runs the process only once.\n\n## CLI parameters\n\n```Shell\nNAME:\n   runner - simple Procfile runner\n\nUSAGE:\n   runner [global options] command [command options] [arguments...]\n\nVERSION:\n   v3 (881f4e039f4ea6342464d4dc6ee3df9d362f5712)\n\nCOMMANDS:\n   logs     Follows logs from running processes\n   help, h  Shows a list of commands or help for one command\n\nGLOBAL OPTIONS:\n   --service-discovery value                            service discovery address (default: \"localhost:64000\")\n   --formation procTypeA:# procTypeB:# ... procTypeN:#  formation allows to control how many instances of a process type are started, format: procTypeA:# procTypeB:# ... procTypeN:#. If `procType` is absent, it is not started. Empty formations start one of each process.\n   --env file                                           environment file to be loaded for all processes, if the file is absent, then this parameter is ignored. (default: \".env\")\n   --skip procTypeA procTypeB procTypeN                 does not run some of the process types, format: procTypeA procTypeB procTypeN\n   --only procTypeA procTypeB procTypeN                 only runs some of the process types, format: procTypeA procTypeB procTypeN\n   --optional procTypeA procTypeB procTypeN             forcefully runs some of the process types, format: procTypeA procTypeB procTypeN\n   --help, -h                                           show help\n   --version, -v                                        print the version\n```\n\n`-env file` loads the environment file common to all process types. It must be\nin the format below:\n```\nVARIABLENAME=VALUE\nVARIABLENAME=VALUE\n```\nNote: one environment variable per line.\n\n`--formation procTypeA:# procTypeB:# ... procTypeN:#` allows to control\nhow many instances of a process type are started, format: procTypeA:#\nprocTypeB:# ... procTypeN:#. If `procType` is absent, it is not started. Empty\nformations start one of each process.\n\n\n## Environment variables available to processes\n\nEach process will have two environment variables available.\n\n`PS` is the name which the runner has christened the process.\n\n`DISCOVERY` is the HTTP service that returns a JSON describing each process\ntype port. This assumes the process has honored the `PORT` variable and bound\nitself to the configured one.\n\n\n## Support\n\n`runner/v3` is only supported in Unix platforms.\n\n## Installation\n\n`go get cirello.io/runner/v3`\n\nhttps://pkg.go.dev/cirello.io/runner/v3\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcirello-io%2Frunner","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcirello-io%2Frunner","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcirello-io%2Frunner/lists"}