Most weboob command-line applications are Read-Eval-Print-Loop, prompting sub-commands, executing them, then prompting for another command.

help [sub-command]

The help sub-command will list all sub-commands. help <sub-command> will display the help of a particular sub-command.

ls

ls is a sub-command present in a few weboob tools.

For example, in boobank, it will list all Account objects. In boobill, it will list all Subscription objects.

boobank> ls
                 Account                     Balance    Coming
------------------------------------------+----------+----------
 #1 (bnporc)     Compte de chèques           2161.30    -452.85
 #2 (bnporc)     Livret Jeune                1600.00       0.00
 #3 (ing)        Compte Titres               2542.00       0.00
------------------------------------------+----------+----------
                                    Total    6303.30    -452.85

count <n>

Most subcommands perform a listing (e.g. ls subcommand for the boobank command) or a search (e.g. search subcommand for videoob command) and display the results. By default, only a limited number of results will be displayed. When the results have been limited, the sub-command will print Hint: There are more results available for %s (use option -n or count command).

Most weboob modules will fetch results lazily: if the limit is set to 10 and the scraped site uses pagination underneath, the weboob module will only fetch the site's pages to return at most 10 results.

The count subcommand is used to change the number of results. For example, the count 50 sub-command will change the limit to 50 results instead of the default (which is often 10). It will affect the sub-commands executed afterwards. count off will disable the limit.

It's possible to pass -n <number> on the weboob command-line.

formatter <form>

Most sub-command display results in a fancy format. It's possible to change the way the results are displayed by changing the formatter. Some formatters are dedicated to a command (for example, the video_list formatter is useless for boobank), but there are generic formatters that will display the data in a more detailed way. The full formatter list can be shown by using formatter list.

Example of generic formatters: table, multiline, csv, json, htmltable.

It's possible to pass -f <formatter> on the weboob command-line.

select <fields>

Generic formatters like table will display by default all fields that have been fetched directly by the module. The select sub-command can be used to only display a subset of the fields (for example select label,balance in boobank), or the opposite, to fetch as much fields as possible, even if it implies to perform heavy operations on the scraped website (with select $full).

It's possible to pass -s <fields> on the weboob command-line.

backends only <backends>

It's possible to only use a subset of the backends, for example backends only foo,bar to use the foo and bar backends.

It's possible to pass -b <backends> on the weboob command-line.