Skip to content

Commit e65159f

Browse files
docs: clarify --dir flag (#2123)
Co-authored-by: Andrey Nering <[email protected]>
1 parent 789a7ea commit e65159f

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

internal/flags/flags.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ func init() {
105105
pflag.BoolVarP(&Dry, "dry", "n", false, "Compiles and prints tasks in the order that they would be run, without executing them.")
106106
pflag.BoolVar(&Summary, "summary", false, "Show summary about a task.")
107107
pflag.BoolVarP(&ExitCode, "exit-code", "x", false, "Pass-through the exit code of the task command.")
108-
pflag.StringVarP(&Dir, "dir", "d", "", "Sets directory of execution.")
108+
pflag.StringVarP(&Dir, "dir", "d", "", "Sets the directory in which Task will execute and look for a Taskfile.")
109109
pflag.StringVarP(&Entrypoint, "taskfile", "t", "", `Choose which Taskfile to run. Defaults to "Taskfile.yml".`)
110110
pflag.StringVarP(&Output.Name, "output", "o", "", "Sets output style: [interleaved|group|prefixed].")
111111
pflag.StringVar(&Output.Group.Begin, "output-group-begin", "", "Message template to print before a task's grouped output.")

website/docs/reference/cli.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ If `--` is given, all remaining arguments will be assigned to a special
2424
| ----- | --------------------------- | -------- | -------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
2525
| `-c` | `--color` | `bool` | `true` | Colored output. Enabled by default. Set flag to `false` or use `NO_COLOR=1` to disable. |
2626
| `-C` | `--concurrency` | `int` | `0` | Limit number tasks to run concurrently. Zero means unlimited. |
27-
| `-d` | `--dir` | `string` | Working directory | Sets directory of execution. |
27+
| `-d` | `--dir` | `string` | Working directory | Sets the directory in which Task will execute and look for a Taskfile. |
2828
| `-n` | `--dry` | `bool` | `false` | Compiles and prints tasks in the order that they would be run, without executing them. |
2929
| `-x` | `--exit-code` | `bool` | `false` | Pass-through the exit code of the task command. |
3030
| `-f` | `--force` | `bool` | `false` | Forces execution even when the task is up-to-date. |

0 commit comments

Comments
 (0)