Skip to content

Commit

Permalink
docs: link to task argument docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jdx committed Sep 27, 2024
1 parent 884ce18 commit 04776a9
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 1 deletion.
2 changes: 1 addition & 1 deletion docs/tasks/file-tasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ test:integration .../.mise/tasks/test/integration
test:units .../.mise/tasks/test/units
```

## Argument parsing with usage
## Arguments

[usage](https://usage.jdx.dev) spec can be used within these files to provide argument parsing, autocompletion,
documentation when running mise and can be exported to markdown. Essentially this turns tasks into
Expand Down
7 changes: 7 additions & 0 deletions docs/tasks/running-tasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,13 @@ mise run build --release

If there are multiple commands, the args are only passed to the last command.

:::tip
You can define arguments/flags for tasks which will provide validation, parsing, autocomplete, and documentation.

* [Arguments in File Tasks](/tasks/file-tasks.html#arguments)
* [Arguments in TOML Tasks](/tasks/toml-tasks.html#arguments)
:::

Multiple tasks/arguments can be separated with this `:::` delimiter:

```bash
Expand Down

0 comments on commit 04776a9

Please sign in to comment.