Skip to content

Commit

Permalink
Make <task> optional and clean up docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dugajean committed Oct 23, 2022
1 parent 98e968c commit fab49cf
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 10 deletions.
18 changes: 11 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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=<a> 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.
Expand Down
6 changes: 3 additions & 3 deletions internal/options.go
Original file line number Diff line number Diff line change
Expand Up @@ -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 <task> [-w|--watch] [-c|--no-cache] [-f|--force] [-q|--quiet] [-a|--args=<a>...]
goke [<task>] [-w|--watch] [-c|--no-cache] [-f|--force] [-q|--quiet] [-a|--args=<a>...]
goke -i | --init
goke -h | --help
goke -v | --version
goke -t | --tasks
goke -t | --tasks
Options:
-h --help Show this screen
Expand Down

0 comments on commit fab49cf

Please sign in to comment.