Skip to content

Commit d9eb966

Browse files
author
elvis kahoro
authored
Merge pull request #116 from warpdotdev/danny/grow-2118-update-workflow-file-format-to-be-more
made the headers more consistent
2 parents ea6ccca + a5221ce commit d9eb966

1 file changed

Lines changed: 12 additions & 12 deletions

File tree

FORMAT.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,45 +5,45 @@ The workflow file format is a [yaml](https://yaml.org/) file and must have eithe
55

66
_Compatibility Note_: Warp is still in Beta and this format is subject to change.
77

8-
### `name`
8+
#### `name`
99
---
1010
The name of the Workflow. Required.
1111

12-
### `command`
12+
#### `command`
1313
----
1414
The command that is executed when the Workflow is selected. Required.
1515

16-
### `tags`
16+
#### `tags`
1717
----
1818
An array of tags that are useful to categorize the Workflow. Optional.
1919

2020
```yaml
2121
tags: ["git", "GitHub"]
2222
```
2323
24-
### `description`
24+
#### `description`
2525
----
2626
The description of the Workflow and what it does. Optional.
2727

28-
### `source_url`
28+
#### `source_url`
2929
----
3030
The URL from where the Workflow was originally generated from. This is surfaced in [commands.dev](https://www.commands.dev/) for attribution purposes. Optional.
3131

3232

33-
### `author`
33+
#### `author`
3434
----
3535
The original author of the Workflow. For example, if this workflow was generated from StackOverflow, the `author` would be the `author` of the StackOverflow post. This is surfaced in [commands.dev](https://www.commands.dev/) for attribution purposes. Optional.
3636

37-
### `author_url`
37+
#### `author_url`
3838
----
3939
The URL of original author of the Workflow. For example, if this workflow was generated from StackOverflow, the `author_url` would be the StackOverflow author's profile page. This is surfaced in [commands.dev](https://www.commands.dev/) for attribution purposes. Optional.
4040

41-
### `shells`
41+
#### `shells`
4242
----
4343
The list of shells where this Workflow is valid. If not specified, the Workflow is assumed to be valid in all shells. This must be one of `zsh`, `bash`, or `fish`.
4444

4545

46-
## `arguments`
46+
#### `arguments`
4747
----
4848
A Workflow can have parameterized arguments to specify pieces of the Workflow that need to be filled in by the user.
4949

@@ -57,7 +57,7 @@ done
5757
```
5858
Includes 3 arguments: `variable`, `sequence`, and `command`.
5959

60-
## `arguments.name`
60+
#### `arguments.name`
6161
-----
6262
The name of the argument. The argument name is used within the command to specify the ranges of the argument. Required.
6363

@@ -69,10 +69,10 @@ arguments:
6969
description: The value to echo
7070
```
7171

72-
## `arguments.description`
72+
#### `arguments.description`
7373
-----
7474
The description of the argument. This is surfaced in both commands.dev and Warp to help users fill in Workflow arguments. Optional
7575

76-
## `arguments.default_value`
76+
#### `arguments.default_value`
7777
-----
7878
The default value for the argument. If specified, the `default_value` replaces the argument name within the command. Optional

0 commit comments

Comments
 (0)