woob-cli.1 4.52 KB
Newer Older
1
.\" -*- coding: utf-8 -*-
Florent's avatar
Florent committed
2
.\" This file was generated automatically by tools/make_man.sh.
Romain Bignon's avatar
Romain Bignon committed
3
.TH WOOB-CLI 1 "11 April 2021" "woob-cli 3\&.0"
4
.SH NAME
5
woob-cli \- call a method on backends
6
.SH SYNOPSIS
7
8
.B woob
cli [\-dqv] [\-b \fIbackends\fR] [\-cnfs] \fIcapability\fR \fImethod\fR [\fIarguments\fR..]
9
.br
10
11
.B woob
cli [\-\-help] [\-\-version]
12
13
14
15

.SH DESCRIPTION
.LP

Romain Bignon's avatar
Romain Bignon committed
16
Console application to call a specific method on backends which implement the given capability.
17

18
.SH CLI COMMANDS
Romain Bignon's avatar
Romain Bignon committed
19
20
21
22
.TP
\fBdebug\fR
.br
Launch a debug Python shell
23
24
25
26
27
28
29
30
31
32
33

.SH OPTIONS
.TP
\fB\-\-version\fR
show program's version number and exit
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-b BACKENDS\fR, \fB\-\-backends=BACKENDS\fR
what backend(s) to enable (comma separated)
Florent's avatar
Florent committed
34
35
36
.TP
\fB\-e EXCLUDE_BACKENDS\fR, \fB\-\-exclude\-backends=EXCLUDE_BACKENDS\fR
what backend(s) to exclude (comma separated)
37
38
39
.TP
\fB\-I\fR, \fB\-\-insecure\fR
do not validate SSL
Florent's avatar
Florent committed
40
41
42
.TP
\fB\-\-nss\fR
Use NSS instead of OpenSSL
Romain Bignon's avatar
Romain Bignon committed
43
44
45
.TP
\fB\-\-auto\-update\fR
Automatically check for updates when a bug in a module is encountered
46
47
48
49

.SH LOGGING OPTIONS
.TP
\fB\-d\fR, \fB\-\-debug\fR
Florent's avatar
Florent committed
50
display debug messages. Set up it twice to more verbosity
51
52
53
54
55
56
57
58
59
60
61
62
.TP
\fB\-q\fR, \fB\-\-quiet\fR
display only error messages
.TP
\fB\-v\fR, \fB\-\-verbose\fR
display info messages
.TP
\fB\-\-logging\-file=LOGGING_FILE\fR
file to save logs
.TP
\fB\-a\fR, \fB\-\-save\-responses\fR
save every response
Florent's avatar
Florent committed
63
64
65
.TP
\fB\-\-export\-session\fR
log browser session cookies after login
66
67
68
69

.SH RESULTS OPTIONS
.TP
\fB\-c CONDITION\fR, \fB\-\-condition=CONDITION\fR
Florent's avatar
Florent committed
70
71
filter result items to display given a boolean expression. See CONDITION section
for the syntax
72
73
.TP
\fB\-n COUNT\fR, \fB\-\-count=COUNT\fR
Florent's avatar
Florent committed
74
limit number of results (from each backends)
75
76
77
78
79
80
81
.TP
\fB\-s SELECT\fR, \fB\-\-select=SELECT\fR
select result item keys to display (comma separated)

.SH FORMATTING OPTIONS
.TP
\fB\-f FORMATTER\fR, \fB\-\-formatter=FORMATTER\fR
Florent's avatar
Florent committed
82
83
select output formatter (csv, htmltable, json, json_line, multiline, simple,
table, webkit)
84
85
86
87
88
89
.TP
\fB\-\-no\-header\fR
do not display header
.TP
\fB\-\-no\-keys\fR
do not display item keys
Romain Bignon's avatar
Romain Bignon committed
90
91
92
.TP
\fB\-O OUTFILE\fR, \fB\-\-outfile=OUTFILE\fR
file to export result
93

Florent's avatar
Florent committed
94
.SH CONDITION
Florent's avatar
Florent committed
95
The \-c and \-\-condition is a flexible way to filter and get only interesting results. It supports conditions on numerical values, dates, durations and strings. Dates are given in YYYY\-MM\-DD or YYYY\-MM\-DD HH:MM format. Durations look like XhYmZs where X, Y and Z are integers. Any of them may be omitted. For instance, YmZs, XhZs or Ym are accepted.
Florent's avatar
Florent committed
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
The syntax of one expression is "\fBfield operator value\fR". The field to test is always the left member of the expression.
.LP
The field is a member of the objects returned by the command. For example, a bank account has "balance", "coming" or "label" fields.
.SS The following operators are supported:
.TP
=
Test if object.field is equal to the value.
.TP
!=
Test if object.field is not equal to the value.
.TP
>
Test if object.field is greater than the value. If object.field is date, return true if value is before that object.field.
.TP
<
Test if object.field is less than the value. If object.field is date, return true if value is after that object.field.
.TP
|
This operator is available only for string fields. It works like the Unix standard \fBgrep\fR command, and returns True if the pattern specified in the value is in object.field.
.SS Expression combination
Florent's avatar
Florent committed
116
117
118
119
.LP
You can make a expression combinations with the keywords \fB" AND "\fR, \fB" OR "\fR an \fB" LIMIT "\fR.
.LP
The \fBLIMIT\fR keyword can be used to limit the number of items upon which running the expression. \fBLIMIT\fR can only be placed at the end of the expression followed by the number of elements you want.
Florent's avatar
Florent committed
120
121
.SS Examples:
.nf
122
.B woob bank ls \-\-condition 'label=Livret A'
Florent's avatar
Florent committed
123
124
125
126
.fi
Display only the "Livret A" account.
.PP
.nf
127
.B woob bank ls \-\-condition 'balance>10000'
Florent's avatar
Florent committed
128
129
130
131
.fi
Display accounts with a lot of money.
.PP
.nf
132
.B woob bank history account@backend \-\-condition 'label|rewe'
Florent's avatar
Florent committed
133
134
135
136
.fi
Get transactions containing "rewe".
.PP
.nf
137
.B woob bank history account@backend \-\-condition 'date>2013\-12\-01 AND date<2013\-12\-09'
Florent's avatar
Florent committed
138
139
.fi
Get transactions betweens the 2th December and 8th December 2013.
Florent's avatar
Florent committed
140
141
.PP
.nf
142
.B woob bank history account@backend \-\-condition 'date>2013\-12\-01  LIMIT 10'
Florent's avatar
Florent committed
143
144
.fi
Get transactions after the 2th December in the last 10 transactions
Florent's avatar
Florent committed
145

146
.SH COPYRIGHT
147
Copyright(C) 2010-2021 Romain Bignon
148
.LP
149
For full copyright information see the COPYING file in the woob package.
150
151
152
.LP
.RE
.SH FILES
153
"~/.config/woob/backends" 
Romain Bignon's avatar
Romain Bignon committed
154
155

.SH SEE ALSO
156
Home page: https://woob.tech/applications/cli