diff --git a/README.md b/README.md index d5d0c0d..f0c4b72 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,51 @@ This project should be considered in beta status. We run it in production at [Wa Where `.` is the folder where the 'root' `bsconfig.json` lives. If you encounter a 'stale build error', either directly, or after a while, a `clean` may be needed to clean up some old compiler assets. +## Full Options + +Find this output by running `yarn rewatch --help`. + +``` +Usage: rewatch [OPTIONS] [COMMAND] [FOLDER] + +Arguments: + [COMMAND] + Possible values: + - build: Build using Rewatch + - watch: Build, then start a watcher + - clean: Clean the build artifacts + + [FOLDER] + The relative path to where the main bsconfig.json resides. IE - the root of your project + +Options: + -f, --filter + Filter allows for a regex to be supplied which will filter the files to be compiled. For instance, to filter out test files for compilation while doing feature work + + -a, --after-build + This allows one to pass an additional command to the watcher, which allows it to run when finished. For instance, to play a sound when done compiling, or to run a test suite. NOTE - You may need to add '--color=always' to your subcommand in case you want to output colour as well + + -n, --no-timing + [possible values: true, false] + + -c, --create-sourcedirs + This creates a source_dirs.json file at the root of the monorepo, which is needed when you want to use Reanalyze + + [possible values: true, false] + + --compiler-args + + + --rescript-version + + + -h, --help + Print help (see a summary with '-h') + + -V, --version + Print version +``` + # Contributing Pre-requisites: