Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/crystal-loot/nox
Procfile-based process manager written in Crystal
https://github.com/crystal-loot/nox
crystal crystal-lang procfile
Last synced: 3 months ago
JSON representation
Procfile-based process manager written in Crystal
- Host: GitHub
- URL: https://github.com/crystal-loot/nox
- Owner: crystal-loot
- License: mit
- Created: 2021-12-23T05:26:19.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-01-26T19:37:46.000Z (12 months ago)
- Last Synced: 2024-11-02T13:33:57.870Z (3 months ago)
- Topics: crystal, crystal-lang, procfile
- Language: Crystal
- Homepage:
- Size: 29.3 KB
- Stars: 17
- Watchers: 2
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# nox
Nox is a process manager for Procfiles written in Crystal.
The reason for its existence is so that [Lucky](https://luckyframework.org/) can ship with a built-in process runner instead of requiring one to be installed.
## Installation
1. Add the dependency to your `shard.yml`:
```yaml
dependencies:
nox:
github: matthewmcgarvey/nox
version: ">= 0.2.0, < 0.3.0"
```
2. Run `shards install`
## Command Line Installation
- Clone the repo
- Run `shards build nox`
- Run `mv bin/nox /usr/local/bin` or to a different location that is on your `$PATH`
## Command Line Usage
```
nox --help # print help info
nox start # run Procfile in current directory
nox start -f Procfile.dev # run Procfile.dev in current directory
```
## Usage
```crystal
require "nox"
Nox.run("Procfile") # runs the Procfile and exits when the processes are all done or the program is interrupted (ctrl-c)
```
## Contributing
1. Fork it ()
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request
## Contributors
- [Matthew McGarvey](https://github.com/matthewmcgarvey) - creator and maintainer