Skip to content

Commit 43f8565

Browse files
committed
feat (docs): active and set command
1 parent ba1d797 commit 43f8565

1 file changed

Lines changed: 42 additions & 0 deletions

File tree

docs/docs/cli/workflows.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,15 @@
22

33
Configure your workflows
44

5+
### Index
6+
- [mailscript workflows:add](#mailscript-workflows:add)
7+
- [mailscript workflows:delete](#mailscript-workflows:delete)
8+
- [mailscript workflows:list](#mailscript-workflows:list)
9+
- [mailscript workflows:inspect](#mailscript-workflows:inspect)
10+
- [mailscript workflows:active](#mailscript-workflows:active)
11+
- [mailscript workflows:set](#mailscript-workflows:set)
12+
13+
514
## `mailscript workflows:add`
615

716
add a workflow
@@ -57,3 +66,36 @@ OPTIONS
5766
-v, --verbose Verbose
5867
5968
```
69+
## `mailscript workflows:active`
70+
71+
Retrieve whether a workflow is enabled or not; Optionally enable/disable a workflow.
72+
73+
```
74+
USAGE
75+
$ mailscript workflows:active ID [VALUE]
76+
77+
ARGUMENTS
78+
ID id of the workflow to be acted on
79+
VALUE "on" or "off"
80+
81+
OPTIONS
82+
-h, --help show CLI help
83+
84+
```
85+
## `mailscript workflows:set`
86+
87+
Set a property of a workflow
88+
89+
```
90+
USAGE
91+
$ mailscript workflows:set ID KEY VALUE
92+
93+
ARGUMENTS
94+
ID id of the workflow to be acted on
95+
KEY key of the property
96+
VALUE value of the property
97+
98+
OPTIONS
99+
-h, --help show CLI help
100+
-t, --type=type type of the value
101+
```

0 commit comments

Comments
 (0)