You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: FORMAT.md
+13-13Lines changed: 13 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,59 +5,59 @@ The workflow file format is a [yaml](https://yaml.org/) file and must have eithe
5
5
6
6
_Compatibility Note_: Warp is still in Beta and this format is subject to change.
7
7
8
-
### `name`
8
+
####`name`
9
9
---
10
10
The name of the Workflow. Required.
11
11
12
-
### `command`
12
+
####`command`
13
13
----
14
14
The command that is executed when the Workflow is selected. Required.
15
15
16
-
### `tags`
16
+
####`tags`
17
17
----
18
18
An array of tags that are useful to categorize the Workflow. Optional.
19
19
20
20
```yaml
21
21
tags: ["git", "GitHub"]
22
22
```
23
23
24
-
### `description`
24
+
####`description`
25
25
----
26
26
The description of the Workflow and what it does. Optional.
27
27
28
-
### `source_url`
28
+
#### `source_url`
29
29
----
30
30
The URL from where the Workflow was originally generated from. This is surfaced in [commands.dev](https://www.commands.dev/) for attribution purposes. Optional.
31
31
32
32
33
-
### `author`
33
+
#### `author`
34
34
----
35
35
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.
36
36
37
-
### `author_url`
37
+
#### `author_url`
38
38
----
39
39
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.
40
40
41
-
### `shells`
41
+
#### `shells`
42
42
----
43
43
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`.
44
44
45
45
46
-
## `arguments`
46
+
#### `arguments`
47
47
----
48
48
A Workflow can have parameterized arguments to specify pieces of the Workflow that need to be filled in by the user.
49
49
50
50
You can specify which part of the Workflow command maps to an argument by surrounding it with two curly braces (`{{<argument>}}`).
51
51
52
52
For example the workflow command:
53
53
```bash
54
-
for {{variable} in {{sequence}}}; do
54
+
for {{variable}} in {{sequence}}; do
55
55
{{command}}
56
56
done
57
57
```
58
58
Includes 3 arguments: `variable`, `sequence`, and `command`.
59
59
60
-
## `arguments.name`
60
+
#### `arguments.name`
61
61
-----
62
62
The name of the argument. The argument name is used within the command to specify the ranges of the argument. Required.
63
63
@@ -69,10 +69,10 @@ arguments:
69
69
description: The value to echo
70
70
```
71
71
72
-
## `arguments.description`
72
+
#### `arguments.description`
73
73
-----
74
74
The description of the argument. This is surfaced in both commands.dev and Warp to help users fill in Workflow arguments. Optional
75
75
76
-
## `arguments.default_value`
76
+
#### `arguments.default_value`
77
77
-----
78
78
The default value for the argument. If specified, the `default_value` replaces the argument name within the command. Optional
# 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.
description: Show streams and format of media file in json format using ffprobe
7
+
arguments:
8
+
- name: media_file_path
9
+
description: Path of media file (may be local file path, http url or some other protocols described at https://ffmpeg.org/ffmpeg-protocols.html#Protocols)
description: "Sorts a text file by line length (including spaces). The `-s` flag indicates that any lines that are the same length are kept in the relative order that they ocurred in the input."
7
+
description: "Sorts a text file by line length (including spaces). The `-s` flag indicates that any lines that are the same length are kept in the relative order that they occurred in the input."
0 commit comments