From fab49cfd0c940f0f81817707aeb15a21feed3827 Mon Sep 17 00:00:00 2001 From: Dugi Date: Sun, 23 Oct 2022 13:45:47 -0600 Subject: [PATCH] Make optional and clean up docs --- README.md | 18 +++++++++++------- internal/options.go | 6 +++--- 2 files changed, 14 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 172996e..738a6f2 100644 --- a/README.md +++ b/README.md @@ -74,13 +74,17 @@ If you omit the task name and only run `goke`, it will look for a `main` task in #### Available flags -| Flag | What it does | -|---|---| -| `--init` | Creates a simple `goke.yml` file in the current directory, if one doesn't already exist | -| `--version` | Prints the current version of goke | -| `--watch` | Runs the given command in _watch_ mode, meaning it will watch the files under `files:` and rerun the command whenever they change | -| `--force` | Runs the given command regardless whether the files under `files:` have changed | -| `--no-cache` | Goke caches the given configuration to speed up execution and avoid parsing the configuration on every run. Clear the cache if you are changing your configuration | +``` +-h --help Show help screen +-v --version Show version +-i --init Creates a goke.yaml file in the current directory +-t --tasks Outputs a list of all task names +-w --watch Run task in watch mode +-c --no-cache Clears the program's cache +-f --force Runs the task even if files have not been changed +-a --args= The arguments and options to pass to the underlying commands +-q --quiet Suppresses all output from tasks +``` ## Tests Goke has some unit test coverage. PR’s are welcome to add more tests. diff --git a/internal/options.go b/internal/options.go index 53bfc3d..010c95d 100644 --- a/internal/options.go +++ b/internal/options.go @@ -6,16 +6,16 @@ import ( "github.com/docopt/docopt-go" ) -const CURRENT_VERSION = "0.2.0" +const CURRENT_VERSION = "0.2.2" const usage = `Goke Usage: - goke [-w|--watch] [-c|--no-cache] [-f|--force] [-q|--quiet] [-a|--args=...] + goke [] [-w|--watch] [-c|--no-cache] [-f|--force] [-q|--quiet] [-a|--args=...] goke -i | --init goke -h | --help goke -v | --version - goke -t | --tasks + goke -t | --tasks Options: -h --help Show this screen