initial commit
1 file changed, 65 insertions(+), 0 deletions(-)
changed files
A README.md
@@ -0,0 +1,65 @@ +# E(a)rl + +E(a)rl helps with your development by restarting your command when files change. + +A file watcher based on things I liked about [nodemon](https://github.com/remy/nodemon) and [watchexec](https://github.com/watchexec/watchexec): + +- When command exits, wait for changes instead of re-starting ad infinitum + +The name is an acronym for "Execute Reload Loop", inspired by "Read Eval Print Loop". "Earl" is nicer to say than "erl", but "erl" is nicer to type on a QWERTY keyboard. + +## Installation + +### Using Nix + +If you have Nix with flakes enabled: + +```bash +nix run git+https:git.alin.ovh/erl -- -exec your-command arg1 arg2 +``` + +Or install it: + +```bash +nix profile install git+https:git.alin.ovh/erl +``` + +## Usage + +Basic usage: + +```bash +erl -exec go run main.go +``` + +### Command Line Options + +- `-exec string` - Command to execute on file change (required) + +### Examples + +**Go development:** +```bash +erl -exec go run . +``` + +**Build and test:** +```bash +erl -exec make test +``` + +## Development + +```bash +nix develop + +just run + +just test + +just build +``` + +## License + +This project is available under the MIT License.