boobill.1 9.73 KB
Newer Older
1
.\" -*- coding: utf-8 -*-
Florent Fourcot's avatar
Florent Fourcot committed
2
.\" This file was generated automatically by tools/make_man.sh.
Romain Bignon's avatar
Romain Bignon committed
3
.TH BOOBILL 1 "27 February 2019" "boobill 1\&.5"
Romain Bignon's avatar
Romain Bignon committed
4
.SH NAME
Florent Fourcot's avatar
Florent Fourcot committed
5
boobill \- get/download documents and bills
Romain Bignon's avatar
Romain Bignon committed
6 7 8 9 10 11 12 13 14 15
.SH SYNOPSIS
.B boobill
[\-dqv] [\-b \fIbackends\fR] [\-cnfs] [\fIcommand\fR [\fIarguments\fR..]]
.br
.B boobill
[\-\-help] [\-\-version]

.SH DESCRIPTION
.LP

Florent Fourcot's avatar
Florent Fourcot committed
16
Console application allowing to get/download documents and bills.
Romain Bignon's avatar
Romain Bignon committed
17 18

.SS Supported websites:
Florent Fourcot's avatar
Florent Fourcot committed
19 20
* amazon (Amazon)
.br
Florent Fourcot's avatar
Florent Fourcot committed
21 22 23 24
* ameli (Ameli website: French Health Insurance)
.br
* amelipro (Ameli website: French Health Insurance for Professionals)
.br
Romain Bignon's avatar
Romain Bignon committed
25 26 27 28
* axabanque (AXA Banque)
.br
* bolden (Bolden)
.br
Florent Fourcot's avatar
Florent Fourcot committed
29 30
* bouygues (Bouygues Télécom French mobile phone provider)
.br
Romain Bignon's avatar
Romain Bignon committed
31 32 33 34
* bp (La Banque Postale)
.br
* caissedepargne (Caisse d'Épargne)
.br
Florent Fourcot's avatar
Florent Fourcot committed
35 36
* cityscoot (Le scooter électrique en libre\-service, sans bornes.)
.br
Romain Bignon's avatar
Romain Bignon committed
37 38
* creditmutuel (Crédit Mutuel)
.br
Florent Fourcot's avatar
Florent Fourcot committed
39
* edf (EDF)
Florent Fourcot's avatar
Florent Fourcot committed
40
.br
Romain Bignon's avatar
Romain Bignon committed
41 42
* ekwateur (ekwateur website)
.br
Florent Fourcot's avatar
Florent Fourcot committed
43 44
* ensap (ensap website)
.br
Romain Bignon's avatar
Romain Bignon committed
45
* freemobile (Free Mobile website)
Romain Bignon's avatar
Romain Bignon committed
46
.br
Romain Bignon's avatar
Romain Bignon committed
47
* infomaniak (Infomaniak)
Florent Fourcot's avatar
Florent Fourcot committed
48
.br
Florent Fourcot's avatar
Florent Fourcot committed
49
* ing (ING Direct)
Florent Fourcot's avatar
Florent Fourcot committed
50
.br
Florent Fourcot's avatar
Florent Fourcot committed
51 52 53 54
* lampiris (French electricity provider Lampiris.fr)
.br
* lcl (LCL)
.br
Florent Fourcot's avatar
Florent Fourcot committed
55 56
* ldlc (ldlc website)
.br
Florent Fourcot's avatar
Florent Fourcot committed
57 58
* materielnet (Materiel.net)
.br
Florent Fourcot's avatar
Florent Fourcot committed
59 60
* myfoncia (Foncia billing capabilities)
.br
Florent Fourcot's avatar
Florent Fourcot committed
61 62
* onlinenet (Online.net)
.br
Florent Fourcot's avatar
Florent Fourcot committed
63 64
* orange (Orange French mobile phone provider)
.br
Florent Fourcot's avatar
Florent Fourcot committed
65
* ovh (Ovh)
Florent Fourcot's avatar
Florent Fourcot committed
66
.br
Florent Fourcot's avatar
Florent Fourcot committed
67
* poivy (Poivy website)
Florent Fourcot's avatar
Florent Fourcot committed
68
.br
Romain Bignon's avatar
Romain Bignon committed
69 70
* societegenerale (Société Générale)
.br
Florent Fourcot's avatar
Florent Fourcot committed
71
* trainline (trainline website)
Romain Bignon's avatar
Romain Bignon committed
72 73
.SH BOOBILL COMMANDS
.TP
Florent Fourcot's avatar
Florent Fourcot committed
74
\fBbalance\fR [\fIID\fR]
Romain Bignon's avatar
Romain Bignon committed
75 76 77
.br
Get balance of subscriptions.
.br
Florent Fourcot's avatar
Florent Fourcot committed
78
If no ID given, display balance of all backends.
Romain Bignon's avatar
Romain Bignon committed
79
.TP
Florent Fourcot's avatar
Florent Fourcot committed
80
\fBbills\fR [\fIID\fR]
Romain Bignon's avatar
Romain Bignon committed
81
.br
Romain Bignon's avatar
Romain Bignon committed
82
Get the list of bills documents for subscriptions.
Romain Bignon's avatar
Romain Bignon committed
83
.br
Romain Bignon's avatar
Romain Bignon committed
84
If no ID given, display bills of all backends
Florent Fourcot's avatar
Florent Fourcot committed
85 86 87 88
.br

.br
Default is limited to 10 results.
Romain Bignon's avatar
Romain Bignon committed
89
.TP
Romain Bignon's avatar
Romain Bignon committed
90 91 92 93
\fBdebug\fR
.br
Launch a debug Python shell
.TP
Romain Bignon's avatar
Romain Bignon committed
94 95 96
\fBdetails\fR [\fIID\fR]
.br
Get details of subscriptions.
Romain Bignon's avatar
Romain Bignon committed
97
.br
Florent Fourcot's avatar
Florent Fourcot committed
98
If no ID given, display all details of all backends.
Romain Bignon's avatar
Romain Bignon committed
99
.TP
Florent Fourcot's avatar
Florent Fourcot committed
100 101 102 103 104 105 106 107 108 109
\fBdocuments\fR [\fIID\fR]
.br
Get the list of documents for subscriptions.
.br
If no ID given, display documents of all backends
.br

.br
Default is limited to 10 results.
.TP
Romain Bignon's avatar
Romain Bignon committed
110
\fBdownload\fR [\fIDOC_ID\fR | all] [\fIFILENAME\fR]
Florent Fourcot's avatar
Florent Fourcot committed
111
.br
Romain Bignon's avatar
Romain Bignon committed
112
download DOC_ID [FILENAME]
Florent Fourcot's avatar
Florent Fourcot committed
113 114
.br

Romain Bignon's avatar
Romain Bignon committed
115
.br
Florent Fourcot's avatar
Florent Fourcot committed
116
download the document
Romain Bignon's avatar
Romain Bignon committed
117
.br
Romain Bignon's avatar
Romain Bignon committed
118
DOC_ID is the identifier of the document (hint: try documents command)
Romain Bignon's avatar
Romain Bignon committed
119 120 121 122
.br
FILENAME is where to write the file. If FILENAME is '\-',
.br
the file is written to stdout.
Florent Fourcot's avatar
Florent Fourcot committed
123 124 125
.br

.br
Romain Bignon's avatar
Romain Bignon committed
126
download all [SUB_ID]
Florent Fourcot's avatar
Florent Fourcot committed
127 128 129
.br

.br
Florent Fourcot's avatar
Florent Fourcot committed
130
You can use special word "all" and download all documents of
Florent Fourcot's avatar
Florent Fourcot committed
131
.br
Romain Bignon's avatar
Romain Bignon committed
132 133 134 135 136
subscription identified by SUB_ID.
.br
If SUB_ID is not given, download documents of all subscriptions.
.TP
\fBdownload_pdf\fR [id | all]
Florent Fourcot's avatar
Florent Fourcot committed
137
.br
Romain Bignon's avatar
Romain Bignon committed
138
download function with forced PDF conversion.
Romain Bignon's avatar
Romain Bignon committed
139
.TP
Florent Fourcot's avatar
Florent Fourcot committed
140
\fBhistory\fR [\fIID\fR]
Romain Bignon's avatar
Romain Bignon committed
141 142
.br
Get the history of subscriptions.
Romain Bignon's avatar
Romain Bignon committed
143
.br
Florent Fourcot's avatar
Florent Fourcot committed
144
If no ID given, display histories of all backends.
Florent Fourcot's avatar
Florent Fourcot committed
145 146 147 148
.br

.br
Default is limited to 10 results.
Romain Bignon's avatar
Romain Bignon committed
149
.TP
Romain Bignon's avatar
Romain Bignon committed
150 151 152 153
\fBprofile\fR
.br
Display detailed information about person or company.
.TP
Romain Bignon's avatar
Romain Bignon committed
154 155
\fBsubscriptions\fR
.br
Florent Fourcot's avatar
Florent Fourcot committed
156
List all subscriptions.
Romain Bignon's avatar
Romain Bignon committed
157 158 159 160 161 162 163 164 165 166
.SH WEBOOB COMMANDS
.TP
\fBbackends\fR [\fIACTION\fR] [\fIBACKEND_NAME\fR]...
.br
Select used backends.
.br

.br
ACTION is one of the following (default: list):
.br
Romain Bignon's avatar
Romain Bignon committed
167
* enable         enable given backends
Romain Bignon's avatar
Romain Bignon committed
168
.br
Romain Bignon's avatar
Romain Bignon committed
169
* disable        disable given backends
Romain Bignon's avatar
Romain Bignon committed
170
.br
Romain Bignon's avatar
Romain Bignon committed
171
* only           enable given backends and disable the others
Romain Bignon's avatar
Romain Bignon committed
172
.br
Romain Bignon's avatar
Romain Bignon committed
173
* list           list backends
Romain Bignon's avatar
Romain Bignon committed
174
.br
Romain Bignon's avatar
Romain Bignon committed
175
* add            add a backend
Romain Bignon's avatar
Romain Bignon committed
176
.br
Romain Bignon's avatar
Romain Bignon committed
177
* register       register a new account on a website
Romain Bignon's avatar
Romain Bignon committed
178
.br
Romain Bignon's avatar
Romain Bignon committed
179
* edit           edit a backend
Romain Bignon's avatar
Romain Bignon committed
180
.br
Romain Bignon's avatar
Romain Bignon committed
181 182 183
* remove         remove a backend
.br
* list\-modules   list modules
Romain Bignon's avatar
Romain Bignon committed
184 185 186 187 188 189 190 191 192 193 194
.TP
\fBcd\fR [\fIPATH\fR]
.br
Follow a path.
.br
".." is a special case and goes up one directory.
.br
"" is a special case and goes home.
.TP
\fBcondition\fR [\fIEXPRESSION\fR | off]
.br
Florent Fourcot's avatar
Florent Fourcot committed
195
If an argument is given, set the condition expression used to filter the results. See CONDITION section for more details and the expression.
Romain Bignon's avatar
Romain Bignon committed
196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252
.br
If the "off" value is given, conditional filtering is disabled.
.br

.br
If no argument is given, print the current condition expression.
.TP
\fBcount\fR [\fINUMBER\fR | off]
.br
If an argument is given, set the maximum number of results fetched.
.br
NUMBER must be at least 1.
.br
"off" value disables counting, and allows infinite searches.
.br

.br
If no argument is given, print the current count value.
.TP
\fBformatter\fR [list | \fIFORMATTER\fR [\fICOMMAND\fR] | option \fIOPTION_NAME\fR [on | off]]
.br
If a FORMATTER is given, set the formatter to use.
.br
You can add a COMMAND to apply the formatter change only to
.br
a given command.
.br

.br
If the argument is "list", print the available formatters.
.br

.br
If the argument is "option", set the formatter options.
.br
Valid options are: header, keys.
.br
If on/off value is given, set the value of the option.
.br
If not, print the current value for the option.
.br

.br
If no argument is given, print the current formatter.
.TP
\fBlogging\fR [\fILEVEL\fR]
.br
Set logging level.
.br

.br
Availables: debug, info, warning, error.
.br
* quiet is an alias for error
.br
* default is an alias for warning
.TP
Florent Fourcot's avatar
Florent Fourcot committed
253
\fBls\fR [\-d] [\-\fIU\fR] [\fIPATH\fR]
Romain Bignon's avatar
Romain Bignon committed
254 255
.br
List objects in current path.
Romain Bignon's avatar
Romain Bignon committed
256 257
.br
If an argument is given, list the specified path.
Florent Fourcot's avatar
Florent Fourcot committed
258
.br
Florent Fourcot's avatar
Florent Fourcot committed
259
Use \-U option to not sort results. It allows you to use a "fast path" to
Florent Fourcot's avatar
Florent Fourcot committed
260 261 262
.br
return results as soon as possible.
.br
Florent Fourcot's avatar
Florent Fourcot committed
263
Use \-d option to display information about a collection (and to not
Florent Fourcot's avatar
Florent Fourcot committed
264 265 266
.br
display the content of it). It has the same behavior than the well
.br
Florent Fourcot's avatar
Florent Fourcot committed
267
known UNIX "ls" command.
Florent Fourcot's avatar
Florent Fourcot committed
268 269 270 271
.br

.br
Default is limited to 40 results.
Romain Bignon's avatar
Romain Bignon committed
272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298
.TP
\fBquit\fR
.br
Quit the application.
.TP
\fBselect\fR [\fIFIELD_NAME\fR]... | "$direct" | "$full"
.br
If an argument is given, set the selected fields.
.br
$direct selects all fields loaded in one http request.
.br
$full selects all fields using as much http requests as necessary.
.br

.br
If no argument is given, print the currently selected fields.

.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 Fourcot's avatar
Florent Fourcot committed
299 300 301
.TP
\fB\-e EXCLUDE_BACKENDS\fR, \fB\-\-exclude\-backends=EXCLUDE_BACKENDS\fR
what backend(s) to exclude (comma separated)
302 303 304
.TP
\fB\-I\fR, \fB\-\-insecure\fR
do not validate SSL
Florent Fourcot's avatar
Florent Fourcot committed
305 306 307
.TP
\fB\-\-nss\fR
Use NSS instead of OpenSSL
Romain Bignon's avatar
Romain Bignon committed
308 309 310
.TP
\fB\-\-auto\-update\fR
Automatically check for updates when a bug in a module is encountered
Romain Bignon's avatar
Romain Bignon committed
311 312 313 314

.SH LOGGING OPTIONS
.TP
\fB\-d\fR, \fB\-\-debug\fR
Florent Fourcot's avatar
Florent Fourcot committed
315
display debug messages. Set up it twice to more verbosity
Romain Bignon's avatar
Romain Bignon committed
316 317 318 319 320 321 322 323 324 325 326 327
.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 Fourcot's avatar
Florent Fourcot committed
328 329 330
.TP
\fB\-\-export\-session\fR
log browser session cookies after login
Romain Bignon's avatar
Romain Bignon committed
331 332 333 334

.SH RESULTS OPTIONS
.TP
\fB\-c CONDITION\fR, \fB\-\-condition=CONDITION\fR
Florent Fourcot's avatar
Florent Fourcot committed
335 336
filter result items to display given a boolean expression. See CONDITION section
for the syntax
Romain Bignon's avatar
Romain Bignon committed
337 338
.TP
\fB\-n COUNT\fR, \fB\-\-count=COUNT\fR
Florent Fourcot's avatar
Florent Fourcot committed
339
limit number of results (from each backends)
Romain Bignon's avatar
Romain Bignon committed
340 341 342 343 344 345 346
.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 Fourcot's avatar
Florent Fourcot committed
347 348
select output formatter (csv, htmltable, json, json_line, multiline, simple,
subscriptions, table, webkit)
Romain Bignon's avatar
Romain Bignon committed
349 350 351 352 353 354 355 356 357 358
.TP
\fB\-\-no\-header\fR
do not display header
.TP
\fB\-\-no\-keys\fR
do not display item keys
.TP
\fB\-O OUTFILE\fR, \fB\-\-outfile=OUTFILE\fR
file to export result

Florent Fourcot's avatar
Florent Fourcot committed
359
.SH CONDITION
Florent Fourcot's avatar
Florent Fourcot committed
360
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 Fourcot's avatar
Florent Fourcot committed
361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380
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 Fourcot's avatar
Florent Fourcot committed
381 382 383 384
.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 Fourcot's avatar
Florent Fourcot committed
385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401
.SS Examples:
.nf
.B boobank ls \-\-condition 'label=Livret A'
.fi
Display only the "Livret A" account.
.PP
.nf
.B boobank ls \-\-condition 'balance>10000'
.fi
Display accounts with a lot of money.
.PP
.nf
.B boobank history account@backend \-\-condition 'label|rewe'
.fi
Get transactions containing "rewe".
.PP
.nf
Florent Fourcot's avatar
Florent Fourcot committed
402
.B boobank history account@backend \-\-condition 'date>2013\-12\-01 AND date<2013\-12\-09'
Florent Fourcot's avatar
Florent Fourcot committed
403 404
.fi
Get transactions betweens the 2th December and 8th December 2013.
Florent Fourcot's avatar
Florent Fourcot committed
405 406 407 408 409
.PP
.nf
.B boobank history account@backend \-\-condition 'date>2013\-12\-01  LIMIT 10'
.fi
Get transactions after the 2th December in the last 10 transactions
Florent Fourcot's avatar
Florent Fourcot committed
410

Romain Bignon's avatar
Romain Bignon committed
411
.SH COPYRIGHT
Romain Bignon's avatar
Romain Bignon committed
412
Copyright(C) 2012-2019 Florent Fourcot
Romain Bignon's avatar
Romain Bignon committed
413
.LP
Florent Fourcot's avatar
Florent Fourcot committed
414
For full copyright information see the COPYING file in the weboob package.
Romain Bignon's avatar
Romain Bignon committed
415 416 417 418 419 420 421
.LP
.RE
.SH FILES
"~/.config/weboob/backends" 

.SH SEE ALSO
Home page: http://weboob.org/applications/boobill