https://github.com/shinshin86/noreman
Clone of foreman and goreman written in Node.js.
https://github.com/shinshin86/noreman
devops foreman goreman nodejs
Last synced: 7 months ago
JSON representation
Clone of foreman and goreman written in Node.js.
- Host: GitHub
- URL: https://github.com/shinshin86/noreman
- Owner: shinshin86
- License: mit
- Created: 2022-05-21T04:35:44.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-07-07T22:24:36.000Z (over 3 years ago)
- Last Synced: 2025-02-03T07:44:35.084Z (9 months ago)
- Topics: devops, foreman, goreman, nodejs
- Language: TypeScript
- Homepage:
- Size: 98.6 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# noreman
[](https://github.com/shinshin86/noreman/actions/workflows/test.yml)
Clone of [foreman](https://github.com/ddollar/foreman) and [goreman](https://github.com/mattn/goreman) written in Node.js.
status of WIP.
## Development
We use [@swc-node/register](https://www.npmjs.com/package/@swc-node/register) to run everything in development with `.ts`.
### start
Executes all commands defined in Procfile and displays output.
```sh
# Procfile must exist in the current directory.
yarn dev start
```
Or, by reading the file `.noreman.json`, you can change the startup path, etc.
example: `.noreman.json`
```json
{
"procfile": "Procfile",
"port": 5000,
"baseDir": "_example",
"basePort": 5000
}
```
When executing, pass the path to `.noreman.json` with the `-c` option.
```sh
yarn dev start -c .noreman.json
```
When use `start` command then RPC server used by noreman is also started in the background.
It is possible to communicate instructions to noreman by hitting `run ` commands from another terminal.
### run list
Checks the current process status.
```sh
yarn dev run list
# display pid option
yarn dev run list -p # or --pid
```
### run restart
Restart a specific process.
```sh
yarn dev run restart foo
```
### run stop
Stop a specific process.
```sh
yarn dev run stop foo
```
### run start
Start a specific process.
```sh
yarn dev run start foo
```
## Build
```sh
yarn build
```
## TODO
[Create a todo item in the issue](https://github.com/shinshin86/noreman/issues?q=is%3Aissue+is%3Aopen+%22TODO%3A%22)