Skip to content

Commit e5079ee

Browse files
committed
doc: document the new CLI features
Signed-off-by: Yves Bastide <yves@botify.com>
1 parent b2f48b8 commit e5079ee

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

docs/src/features/command_line.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,19 @@ Command Line
44
Simpleflow comes with a `simpleflow` command-line utility that can be used to list workflows against SWF,
55
boot decider or activity workers (with multiprocessing), and a few other goodies.
66

7+
Most commands require the SWF domain.
8+
Several of them (not all, alas) can take it from the environment variable `SWF_DOMAIN`.
9+
10+
Likewise, there is a pair of global options:
11+
12+
- `--format csv|tsv|tabular|human|json|prettyjson` (default: `tabular`)
13+
- `--header/--no-header` (default: no header)
14+
15+
The plain `json` format returns an array of arrays; `prettyjson` or `--json --header` returns an
16+
array of objects, as expected.
17+
**FIXME: `prettyjson` is not an adequate name...**
18+
19+
The output format can also come from the environment variable `SIMPLEFLOW_FORMAT`.
720

821
List Workflow Executions
922
------------------------
@@ -47,6 +60,22 @@ You can profile the execution of the workflow with:
4760
activity-examples.basic.increment-1 completed 2015-08-04 23:04 102.20 2015-08-04 23:06 0.79 2015-08-04 23:06 0.65
4861

4962

63+
Find workflows
64+
--
65+
66+
The `workflow.filter` command is mainly useful to find either running workflow or failed workflows
67+
on a given period.
68+
It accepts many different options; please see the help blurb 🙂
69+
70+
71+
Retrieve workflow history
72+
--
73+
74+
The `workflow.history` command retrieves the SWF history associated with a given workflow.
75+
It only works in “pretty JSON” mode.
76+
Several output formats are available, from a raw events output to a per-activity/children workflows/etc. view.
77+
78+
5079
Controlling SWF access
5180
----------------------
5281

0 commit comments

Comments
 (0)