|
1 | 1 | # Workflows |
2 | 2 |
|
3 | | -The repo for all _global_ Workflows that appear within Warp and within [commands.dev](https://www.commands.dev/). |
| 3 | +The repo for all _public_ Workflows that appear within Warp and within [commands.dev](https://www.commands.dev/). |
4 | 4 |
|
5 | 5 | **To learn how to create local or repository workflows, see [our docs](https://github.com/warpdotdev/warp-internal/pull/2205).** |
6 | 6 |
|
@@ -31,8 +31,10 @@ Additionally, see the workflow below as an example to quickly get started: |
31 | 31 | # The name of the workflow. |
32 | 32 | name: Uninstall a Homebrew package and all of its dependencies |
33 | 33 | # The corresponding command for the workflow. Any arguments should be surrounded with two curly braces. E.g `command {{arg}}`. |
34 | | -command: "brew tap beeftornado/rmtree\nbrew rmtree {{package_name}}" |
35 | | -# Any tags that workflow should be categorized with. |
| 34 | +command: |- |
| 35 | + brew tap beeftornado/rmtree |
| 36 | + brew rmtree {{package_name}} |
| 37 | +# Any tags that the workflow should be categorized with. |
36 | 38 | tags: |
37 | 39 | - homebrew |
38 | 40 | # A description the workflow. |
@@ -83,8 +85,9 @@ cargo build |
83 | 85 | ### What Makes a Useful Workflow? |
84 | 86 | A good workflow is one that includes a command with many flags or arguments or one that is hard to remember. |
85 | 87 |
|
86 | | -Additionally, a workflow should include: |
| 88 | +Additionally, a workflow _must_ include: |
87 | 89 |
|
88 | | -* A descriptive title that includes the name of the command. |
89 | | -* A description for the workflow and each of its argument, if applicable. |
| 90 | +* A descriptive title that includes the name of the command--this is useful for improving the experience of searching for workflows in Warp or [commands.dev](https://www.commands.dev/). |
| 91 | +* A tag that accurately categorizes the workflows. We ask that you avoid many repetitive tags to improve searchability of workflows within Warp. |
| 92 | +* A description for the workflow and each of its arguments, if applicable. |
90 | 93 | * A default value for each argument, if applicable. |
0 commit comments