{"id":14235879,"url":"https://github.com/chrismytton/shoreman","last_synced_at":"2025-06-15T09:14:34.840Z","repository":{"id":42972440,"uuid":"2540060","full_name":"chrismytton/shoreman","owner":"chrismytton","description":":shell: foreman in shell","archived":false,"fork":false,"pushed_at":"2025-01-30T11:05:25.000Z","size":656,"stargazers_count":298,"open_issues_count":0,"forks_count":29,"subscribers_count":12,"default_branch":"master","last_synced_at":"2025-06-08T00:36:50.998Z","etag":null,"topics":["foreman","procfile","shell"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/chrismytton.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"SECURITY.md","support":null}},"created_at":"2011-10-08T21:21:35.000Z","updated_at":"2025-05-01T23:15:04.000Z","dependencies_parsed_at":"2022-08-29T17:51:59.844Z","dependency_job_id":null,"html_url":"https://github.com/chrismytton/shoreman","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/chrismytton/shoreman","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrismytton%2Fshoreman","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrismytton%2Fshoreman/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrismytton%2Fshoreman/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrismytton%2Fshoreman/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/chrismytton","download_url":"https://codeload.github.com/chrismytton/shoreman/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrismytton%2Fshoreman/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259949637,"owners_count":22936416,"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":["foreman","procfile","shell"],"created_at":"2024-08-20T21:02:27.559Z","updated_at":"2025-06-15T09:14:29.820Z","avatar_url":"https://github.com/chrismytton.png","language":"Shell","funding_links":[],"categories":["Process Manager","Shell"],"sub_categories":["Procfile"],"readme":"shoreman(1) ![CI](https://github.com/chrismytton/shoreman/workflows/CI/badge.svg?branch=master\u0026event=push)\n===========\n\nA shell implementation of [Foreman](https://github.com/ddollar/foreman). Starts the process formations defined in a `Procfile`.\n\n## Install\n\n### macOS with Homebrew\n\n    brew install chrismytton/formula/shoreman\n\n### Standalone\n\nInstall as a standalone, change `~/bin/` to any other directory that's\nin your `$PATH` if you wish.\n\n```\ncurl https://github.com/chrismytton/shoreman/raw/master/shoreman.sh -sLo ~/bin/shoreman \u0026\u0026 \\\nchmod 755 ~/bin/shoreman\n```\n\n## Usage\n\nHead into a project that has a `Procfile` in it, then simply run the\n`shoreman` command. It will read your Procfile, and start up the\nprocesses it finds. If there is a `.env` file in the directory then\nenvironment variables will be read from it, as with foreman.\n\n```\ncd project-with-procfile\nshoreman\n```\n\n## Running tests\n\nTests are written using [roundup](https://github.com/bmizerany/roundup).\n\nTo run the tests, go to the root of the repository then run `make`.\n\n```\ncd shoreman\nmake\n```\n\n## Annotated source code\n\nThere's a literate-programming-style annotated version of the source code available at https://www.chrismytton.uk/shoreman/.\n\n### Generate documentation from source code\n\n```\nnpm install -g docco\ndocco -l linear shoreman.sh\n```\n\nThis puts the documentation in a `docs/` directory. You'll then need to manually\ncopy the contents of that directory over to the `gh-pages` branch and run\n`mv shoreman.html index.html` in order to publish it to GitHub Pages.\n\n## Projects using shoreman\n\n- [dokku-shoreman](https://github.com/statianzo/dokku-shoreman) a plugin\n  for [dokku](https://github.com/progrium/dokku) to allow it to run\n  multiple process types.\n\n## Contributors\n\nSee the [contributors](https://github.com/chrismytton/shoreman/graphs/contributors) section of GitHub Insights for this repository.\n\n## Credits\n\nInspired by the original [Foreman](https://github.com/ddollar/foreman)\nby David Dollar (@ddollar).\n\nCopyright (c) Chris Mytton\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchrismytton%2Fshoreman","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchrismytton%2Fshoreman","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchrismytton%2Fshoreman/lists"}