Ubuntu Manpage: boobank - manage bank accounts

NAME

       boobank - manage bank accounts

SYNOPSIS

       boobank [-dqv] [-b backends] [-cnfs] [command [arguments..]]
       boobank [--help] [--version]

DESCRIPTION

       Console  application  allowing  to  list your bank accounts and get their balance, display
       accounts history and coming bank operations, and transfer money from an account to another
       (if available).

   Supported websites:
       * afer (afer website)
       * alloresto (Allo Resto)
       * amazonstorecard (Amazon Store Card)
       * americanexpress (American Express)
       * amundi (amundi website)
       * apivie (Apivie)
       * axabanque (AXA Banque)
       * banqueaccord (Banque Accord)
       * banquepopulaire (Banque Populaire)
       * barclays (Barclays)
       * bforbank (BforBank)
       * bnporc (BNP Paribas)
       * boursorama (Boursorama)
       * bp (La Banque Postale)
       * bred (Bred)
       * caels (Crédit Agricole - Epargne Longue des Salariés)
       * caissedepargne (Caisse d'Épargne)
       * carrefourbanque (Carrefour Banque)
       * cic (CIC)
       * citelis (Citélis)
       * citibank (Citibank)
       * cmb (Credit Mutuel de Bretagne)
       * cmso (Crédit Mutuel Sud-Ouest)
       * cragr (Crédit Agricole)
       * creditcooperatif (Crédit Coopératif)
       *   creditdunord  (Crédit  du  Nord,  Banque  Courtois,  Kolb,  Nuger,  Tarneaud,  Société
       Marseillaise de Crédit)
       * creditdunordpee (Site de gestion du PEE du groupe Credit du nord)
       * creditmutuel (Crédit Mutuel)
       * delubac (Banque Delubac & Cie)
       * fortuneo (Fortuneo)
       * ganassurances (Groupama)
       * groupamaes (Groupama Épargne Salariale)
       * hsbc (HSBC France)
       * ing (ING Direct)
       * kiwibank (Kiwibank)
       * lcl (LCL)
       * n26 (Bank N26)
       * oney (Oney)
       * paypal (PayPal)
       * s2e (Épargne Salariale)
       * societegenerale (Société Générale)
       * spirica (Spirica)
       * vicseccard (Victoria's Secret Angel Card)
       * wellsfargo (Wells Fargo)
       * yomoni (Yomoni)

BOOBANK COMMANDS

       advisor
              Display advisors.

       budgea USERNAME PASSWORD
              Export your bank accounts and transactions to Budgea.

              Budgea is an online web and mobile application to manage your bank
              accounts. To avoid giving your credentials to this service, you can use
              this command.

              https://www.budgea.com

       coming ID [END_DATE]
              Display future transactions.

              If END_DATE is supplied, show all transactions until this date.

              Default is limited to 10 results.

       history ID [END_DATE]
              Display history of transactions.

              If END_DATE is supplied, list all transactions until this date.

              Default is limited to 10 results.

       investment ID
              Display investments of an account.

       list [-U]
              List accounts.
              Use -U to disable sorting of results.

       transfer ACCOUNT [RECIPIENT AMOUNT [REASON]]
              Make a transfer beetwen two account
              - ACCOUNT    the source account
              - RECIPIENT  the recipient
              - AMOUNT     amount to transfer
              - REASON     reason of transfer

              If you give only the ACCOUNT parameter, it lists all the
              available recipients for this account.

WEBOOB COMMANDS

backends [ACTION] [BACKEND_NAME]...
Select used backends.

ACTION is one of the following (default: list):
* enable enable given backends
* disable disable given backends
* only enable given backends and disable the others
* list list backends
* add add a backend
* register register a new account on a website
* edit edit a backend
* remove remove a backend
* list-modules list modules

cd [PATH]
Follow a path.
".." is a special case and goes up one directory.
"" is a special case and goes home.

condition [EXPRESSION | off]
If an argument is given, set the condition expression used to filter the results.
See CONDITION section for more details and the expression.
If the "off" value is given, conditional filtering is disabled.

If no argument is given, print the current condition expression.

count [NUMBER | off]
If an argument is given, set the maximum number of results fetched.
NUMBER must be at least 1.
"off" value disables counting, and allows infinite searches.

If no argument is given, print the current count value.

formatter [list | FORMATTER [COMMAND] | option OPTION_NAME [on | off]]
If a FORMATTER is given, set the formatter to use.
You can add a COMMAND to apply the formatter change only to
a given command.

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

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

If no argument is given, print the current formatter.

logging [LEVEL]
Set logging level.

Availables: debug, info, warning, error.
* quiet is an alias for error
* default is an alias for warning

ls [-d] [-U] [PATH]
List objects in current path.
If an argument is given, list the specified path.
Use -U option to not sort results. It allows you to use a "fast path" to
return results as soon as possible.
Use -d option to display information about a collection (and to not
display the content of it). It has the same behavior than the well
known UNIX "ls" command.

Default is limited to 40 results.

quit
Quit the application.

select [FIELD_NAME]... | "$direct" | "$full"
If an argument is given, set the selected fields.
$direct selects all fields loaded in one http request.
$full selects all fields using as much http requests as necessary.

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

OPTIONS

       --version
              show program's version number and exit

       -h, --help
              show this help message and exit

       -b BACKENDS, --backends=BACKENDS
              what backend(s) to enable (comma separated)

       -e EXCLUDE_BACKENDS, --exclude-backends=EXCLUDE_BACKENDS
              what backend(s) to exclude (comma separated)

       -I, --insecure
              do not validate SSL

LOGGING OPTIONS

       -d, --debug
              display debug messages. Set up it twice to more verbosity

       -q, --quiet
              display only error messages

       -v, --verbose
              display info messages

       --logging-file=LOGGING_FILE
              file to save logs

       -a, --save-responses
              save every response

RESULTS OPTIONS

       -c CONDITION, --condition=CONDITION
              filter  result  items  to display given a boolean expression. See CONDITION section
              for the syntax

       -n COUNT, --count=COUNT
              limit number of results (from each backends)

       -s SELECT, --select=SELECT
              select result item keys to display (comma separated)

FORMATTING OPTIONS

       -f FORMATTER, --formatter=FORMATTER
              select   output   formatter   (account_list,    advisor_list,    csv,    htmltable,
              investment_list,  json,  json_line,  multiline,  ofx,  ops_list,  pretty_qif,  qif,
              recipient_list, simple, table, transfer, webkit)

       --no-header
              do not display header

       --no-keys
              do not display item keys

       -O OUTFILE, --outfile=OUTFILE
              file to export result

CONDITION

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. The
syntax of one expression is "field operator value". The field to test is always the left
member of the expression.

The field is a member of the objects returned by the command. For example, a bank account
has "balance", "coming" or "label" fields.

The following operators are supported:
= Test if object.field is equal to the value.

!= Test if object.field is not equal to the value.

> Test if object.field is greater than the value. If object.field is date, return
true if value is before that object.field.

< Test if object.field is less than the value. If object.field is date, return true
if value is after that object.field.

| This operator is available only for string fields. It works like the Unix standard
grep command, and returns True if the pattern specified in the value is in
object.field.

Expression combination
You can make a expression combinations with the keywords " AND ", " OR " an " LIMIT ".

The LIMIT keyword can be used to limit the number of items upon which running the
expression. LIMIT can only be placed at the end of the expression followed by the number
of elements you want.

Examples:
boobank ls --condition 'label=Livret A'
Display only the "Livret A" account.

boobank ls --condition 'balance>10000'
Display accounts with a lot of money.

boobank history account@backend --condition 'label|rewe'
Get transactions containing "rewe".

boobank history account@backend --condition 'date>2013-12-01 AND date<2013-12-09'
Get transactions betweens the 2th December and 8th December 2013.

boobank history account@backend --condition 'date>2013-12-01 LIMIT 10'
Get transactions after the 2th December in the last 10 transactions

COPYRIGHT

       Copyright(C) 2010-2017 Romain Bignon, Christophe Benz

       For full copyright information see the COPYING file in the weboob package.

FILES

       "~/.config/weboob/backends"