Skip to content
boobill.1 10.2 KiB
Newer Older
.\" -*- coding: utf-8 -*-
Florent's avatar
Florent committed
.\" This file was generated automatically by tools/make_man.sh.
Romain Bignon's avatar
Romain Bignon committed
.TH BOOBILL 1 "13 February 2020" "boobill 2\&.0"
Romain Bignon's avatar
Romain Bignon committed
.SH NAME
Florent's avatar
Florent committed
boobill \- get/download documents and bills
Romain Bignon's avatar
Romain Bignon committed
.SH SYNOPSIS
.B boobill
[\-dqv] [\-b \fIbackends\fR] [\-cnfs] [\fIcommand\fR [\fIarguments\fR..]]
.br
.B boobill
[\-\-help] [\-\-version]

.SH DESCRIPTION
.LP

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

.SS Supported websites:
Florent's avatar
Florent committed
* amazon (Amazon)
.br
Romain Bignon's avatar
Romain Bignon committed
* ameli (le site de l'Assurance Maladie en ligne)
Florent's avatar
Florent committed
.br
* amelipro (Ameli website: French Health Insurance for Professionals)
.br
Romain Bignon's avatar
Romain Bignon committed
* axabanque (AXA Banque)
.br
Romain Bignon's avatar
Romain Bignon committed
* banquepopulaire (Banque Populaire)
.br
* bnporc (BNP Paribas)
.br
Romain Bignon's avatar
Romain Bignon committed
* bolden (Bolden)
.br
Romain Bignon's avatar
Romain Bignon committed
* bouygues (Bouygues Télécom)
Florent's avatar
Florent committed
.br
Romain Bignon's avatar
Romain Bignon committed
* bp (La Banque Postale)
.br
* caissedepargne (Caisse d'Épargne)
.br
Romain Bignon's avatar
Romain Bignon committed
* cesu (Le Cesu est une offre simplifiée pour déclarer facilement la rémunération de votre salarié à domicile pour des activités de service à la personne.)
.br
Florent's avatar
Florent committed
* cityscoot (Le scooter électrique en libre\-service, sans bornes.)
.br
Romain Bignon's avatar
Romain Bignon committed
* creditmutuel (Crédit Mutuel)
.br
Florent's avatar
Florent committed
* edf (EDF)
Florent's avatar
Florent committed
.br
Romain Bignon's avatar
Romain Bignon committed
* ekwateur (ekwateur website)
.br
Florent's avatar
Florent committed
* ensap (ensap website)
.br
Romain Bignon's avatar
Romain Bignon committed
* freemobile (Free Mobile website)
Romain Bignon's avatar
Romain Bignon committed
.br
Romain Bignon's avatar
Romain Bignon committed
* infomaniak (Infomaniak)
Florent's avatar
Florent committed
.br
Romain Bignon's avatar
Romain Bignon committed
* ing (ING France)
Florent's avatar
Florent committed
.br
Florent's avatar
Florent committed
* lampiris (French electricity provider Lampiris.fr)
.br
* lcl (LCL)
.br
Florent's avatar
Florent committed
* ldlc (ldlc website)
.br
Romain Bignon's avatar
Romain Bignon committed
* lucca (Lucca RH)
.br
Florent's avatar
Florent committed
* materielnet (Materiel.net)
.br
Florent's avatar
Florent committed
* myfoncia (Foncia billing capabilities)
.br
Florent's avatar
Florent committed
* onlinenet (Online.net)
.br
Florent's avatar
Florent committed
* orange (Orange French mobile phone provider)
.br
Florent's avatar
Florent committed
* ovh (Ovh)
Florent's avatar
Florent committed
.br
Romain Bignon's avatar
Romain Bignon committed
* pajemploi (Pajemploi est une offre de service du réseau des Urssaf, destinée à simplifier les formalités administratives pour les parents employeurs qui font garder leur(s) enfant(s) par une assistante maternelle agréée ou une garde d’enfants à domicile.)
.br
Florent's avatar
Florent committed
* poivy (Poivy website)
Florent's avatar
Florent committed
.br
Romain Bignon's avatar
Romain Bignon committed
* societegenerale (Société Générale)
.br
Romain Bignon's avatar
Romain Bignon committed
* trainline (trainline)
Romain Bignon's avatar
Romain Bignon committed
.SH BOOBILL COMMANDS
.TP
Florent's avatar
Florent committed
\fBbalance\fR [\fIID\fR]
Romain Bignon's avatar
Romain Bignon committed
.br
Get balance of subscriptions.
.br
Florent's avatar
Florent committed
If no ID given, display balance of all backends.
Romain Bignon's avatar
Romain Bignon committed
.TP
Florent's avatar
Florent committed
\fBbills\fR [\fIID\fR]
Romain Bignon's avatar
Romain Bignon committed
.br
Romain Bignon's avatar
Romain Bignon committed
Get the list of bills documents for subscriptions.
Romain Bignon's avatar
Romain Bignon committed
.br
Romain Bignon's avatar
Romain Bignon committed
If no ID given, display bills of all backends
Florent's avatar
Florent committed
.br

.br
Default is limited to 10 results.
Romain Bignon's avatar
Romain Bignon committed
.TP
Romain Bignon's avatar
Romain Bignon committed
\fBdebug\fR
.br
Launch a debug Python shell
.TP
Romain Bignon's avatar
Romain Bignon committed
\fBdetails\fR [\fIID\fR]
.br
Get details of subscriptions.
Romain Bignon's avatar
Romain Bignon committed
.br
Florent's avatar
Florent committed
If no ID given, display all details of all backends.
Romain Bignon's avatar
Romain Bignon committed
.TP
Florent's avatar
Florent committed
\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
\fBdownload\fR [\fIDOC_ID\fR | all] [\fIFILENAME\fR]
Florent's avatar
Florent committed
.br
Romain Bignon's avatar
Romain Bignon committed
download DOC_ID [FILENAME]
Florent's avatar
Florent committed
.br

Romain Bignon's avatar
Romain Bignon committed
.br
Florent's avatar
Florent committed
download the document
Romain Bignon's avatar
Romain Bignon committed
.br
Romain Bignon's avatar
Romain Bignon committed
DOC_ID is the identifier of the document (hint: try documents command)
Romain Bignon's avatar
Romain Bignon committed
.br
FILENAME is where to write the file. If FILENAME is '\-',
.br
the file is written to stdout.
Florent's avatar
Florent committed
.br

.br
Romain Bignon's avatar
Romain Bignon committed
download all [SUB_ID]
Florent's avatar
Florent committed
.br

.br
Florent's avatar
Florent committed
You can use special word "all" and download all documents of
Florent's avatar
Florent committed
.br
Romain Bignon's avatar
Romain Bignon committed
subscription identified by SUB_ID.
.br
If SUB_ID is not given, download documents of all subscriptions.
.TP
\fBdownload_pdf\fR [id | all]
Florent's avatar
Florent committed
.br
Romain Bignon's avatar
Romain Bignon committed
download function with forced PDF conversion.
Romain Bignon's avatar
Romain Bignon committed
.TP
Florent's avatar
Florent committed
\fBhistory\fR [\fIID\fR]
Romain Bignon's avatar
Romain Bignon committed
.br
Get the history of subscriptions.
Romain Bignon's avatar
Romain Bignon committed
.br
Florent's avatar
Florent committed
If no ID given, display histories of all backends.
Florent's avatar
Florent committed
.br

.br
Default is limited to 10 results.
Romain Bignon's avatar
Romain Bignon committed
.TP
Romain Bignon's avatar
Romain Bignon committed
\fBprofile\fR
.br
Display detailed information about person or company.
.TP
Romain Bignon's avatar
Romain Bignon committed
\fBsubscriptions\fR
.br
Florent's avatar
Florent committed
List all subscriptions.
Romain Bignon's avatar
Romain Bignon committed
.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
* enable         enable given backends
Romain Bignon's avatar
Romain Bignon committed
.br
Romain Bignon's avatar
Romain Bignon committed
* disable        disable given backends
Romain Bignon's avatar
Romain Bignon committed
.br
Romain Bignon's avatar
Romain Bignon committed
* only           enable given backends and disable the others
Romain Bignon's avatar
Romain Bignon committed
.br
Romain Bignon's avatar
Romain Bignon committed
* list           list backends
Romain Bignon's avatar
Romain Bignon committed
.br
Romain Bignon's avatar
Romain Bignon committed
* add            add a backend
Romain Bignon's avatar
Romain Bignon committed
.br
Romain Bignon's avatar
Romain Bignon committed
* register       register a new account on a website
Romain Bignon's avatar
Romain Bignon committed
.br
Romain Bignon's avatar
Romain Bignon committed
* edit           edit a backend
Romain Bignon's avatar
Romain Bignon committed
.br
Romain Bignon's avatar
Romain Bignon committed
* remove         remove a backend
.br
* list\-modules   list modules
Romain Bignon's avatar
Romain Bignon committed
.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's avatar
Florent committed
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
.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's avatar
Florent committed
\fBls\fR [\-d] [\-\fIU\fR] [\fIPATH\fR]
Romain Bignon's avatar
Romain Bignon committed
.br
List objects in current path.
Romain Bignon's avatar
Romain Bignon committed
.br
If an argument is given, list the specified path.
Florent's avatar
Florent committed
.br
Florent's avatar
Florent committed
Use \-U option to not sort results. It allows you to use a "fast path" to
Florent's avatar
Florent committed
.br
return results as soon as possible.
.br
Florent's avatar
Florent committed
Use \-d option to display information about a collection (and to not
Florent's avatar
Florent committed
.br
display the content of it). It has the same behavior than the well
.br
Florent's avatar
Florent committed
known UNIX "ls" command.
Florent's avatar
Florent committed
.br

.br
Default is limited to 40 results.
Romain Bignon's avatar
Romain Bignon committed
.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's avatar
Florent committed
.TP
\fB\-e EXCLUDE_BACKENDS\fR, \fB\-\-exclude\-backends=EXCLUDE_BACKENDS\fR
what backend(s) to exclude (comma separated)
.TP
\fB\-I\fR, \fB\-\-insecure\fR
do not validate SSL
Florent's avatar
Florent committed
.TP
\fB\-\-nss\fR
Use NSS instead of OpenSSL
Romain Bignon's avatar
Romain Bignon committed
.TP
\fB\-\-auto\-update\fR
Automatically check for updates when a bug in a module is encountered
Romain Bignon's avatar
Romain Bignon committed

.SH LOGGING OPTIONS
.TP
\fB\-d\fR, \fB\-\-debug\fR
Florent's avatar
Florent committed
display debug messages. Set up it twice to more verbosity
Romain Bignon's avatar
Romain Bignon committed
.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
.TP
\fB\-\-export\-session\fR
log browser session cookies after login
Romain Bignon's avatar
Romain Bignon committed

.SH RESULTS OPTIONS
.TP
\fB\-c CONDITION\fR, \fB\-\-condition=CONDITION\fR
Florent's avatar
Florent committed
filter result items to display given a boolean expression. See CONDITION section
for the syntax
Romain Bignon's avatar
Romain Bignon committed
.TP
\fB\-n COUNT\fR, \fB\-\-count=COUNT\fR
Florent's avatar
Florent committed
limit number of results (from each backends)
Romain Bignon's avatar
Romain Bignon committed
.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
select output formatter (csv, htmltable, json, json_line, multiline, simple,
subscriptions, table, webkit)
Romain Bignon's avatar
Romain Bignon committed
.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's avatar
Florent committed
.SH CONDITION
Florent's avatar
Florent committed
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
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
.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
.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's avatar
Florent committed
.B boobank history account@backend \-\-condition 'date>2013\-12\-01 AND date<2013\-12\-09'
Florent's avatar
Florent committed
.fi
Get transactions betweens the 2th December and 8th December 2013.
Florent's avatar
Florent committed
.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's avatar
Florent committed

Romain Bignon's avatar
Romain Bignon committed
.SH COPYRIGHT
Romain Bignon's avatar
Romain Bignon committed
Copyright(C) 2012-2020 Florent Fourcot
Romain Bignon's avatar
Romain Bignon committed
.LP
Florent's avatar
Florent committed
For full copyright information see the COPYING file in the weboob package.
Romain Bignon's avatar
Romain Bignon committed
.LP
.RE
.SH FILES
"~/.config/weboob/backends" 

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