1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
|
.\" Manpage for ecflow_client.
.TH ECFLOW_CLIENT 1 "March 7, 2026" "1.0" "ECFLOW_CLIENT User Manual"
.SH NAME
ecflow_client \- command-line client for interacting with ECFlow servers
.SH SYNOPSIS
.B ecflow_client
[\fIOPTIONS\fR] [\fISUBCOMMAND\fR] [\fIARGS\fR...]
.SH DESCRIPTION
.B ecflow_client
is a command-line tool for interacting with ECFlow servers. It allows users to submit, monitor, and control workflows, as well as query server status and job information.
.SH OPTIONS
.TP
\fB\-h\fR, \fB\-\-help\fR
Show help message and exit.
.TP
\fB\-v\fR, \fB\-\-version\fR
Show version information and exit.
.TP
\fB\-s\fR \fISERVER\fR, \fB\-\-server\fR=\fISERVER\fR
Specify the ECFlow server to connect to.
.TP
\fB\-p\fR \fIPORT\fR, \fB\-\-port\fR=\fIPORT\fR
Specify the port number of the ECFlow server.
.TP
\fB\-u\fR \fIUSER\fR, \fB\-\-user\fR=\fIUSER\fR
Specify the username for authentication.
.TP
\fB\-P\fR \fIPASSWORD\fR, \fB\-\-password\fR=\fIPASSWORD\fR
Specify the password for authentication.
.SH SUBCOMMANDS
.TP
\fBsubmit\fR \fIFILE\fR
Submit a workflow definition file to the server.
.TP
\fBstatus\fR [\fIPATH\fR]
Show the status of a workflow or node.
.TP
\fBbegin\fR \fIPATH\fR
Begin a suite, family, or task.
.TP
\fBkill\fR \fIPATH\fR
Kill a running task or abort a suite.
.TP
\fBquery\fR \fIPATH\fR
Query information about a node.
.TP
\fBlog\fR \fIPATH\fR
Retrieve the log output of a task.
.SH EXAMPLES
.TP
.B ecflow_client \-s ecflow.example.com \-p 3141 \-u user submit workflow.def
Submit a workflow definition file to the server.
.TP
.B ecflow_client \-s ecflow.example.com status /suite/family
Show the status of a workflow node.
.TP
.B ecflow_client \-s ecflow.example.com begin /suite/family/task
Begin a task.
.SH ENVIRONMENT
.TP
\fBECFLOW_SERVER\fR
Default ECFlow server address.
.TP
\fBECFLOW_PORT\fR
Default ECFlow server port.
.TP
\fBECFLOW_USER\fR
Default username for authentication.
.SH FILES
.TP
\fI~/.ecflowrc\fR
Configuration file for default settings.
.SH SEE ALSO
.BR ecflow (1),
.BR ecflow_ui (1)
.SH BUGS
Report bugs to the ECFlow issue tracker.
.SH AUTHOR
Alastair McKinstry <mckinstry@debian.org>
|
