Skip to content
woob-repos.1 5.31 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 WOOB-REPOS 1 "11 April 2021" "woob-repos 3\&.0"
Romain Bignon's avatar
Romain Bignon committed
.SH NAME
woob-repos \- manage a woob repository
Romain Bignon's avatar
Romain Bignon committed
.SH SYNOPSIS
.B woob
repos [\-dqv] [\-b \fIbackends\fR] [\-cnfs] [\fIcommand\fR [\fIarguments\fR..]]
Romain Bignon's avatar
Romain Bignon committed
.br
Romain Bignon's avatar
Romain Bignon committed

.SH DESCRIPTION
.LP

Romain Bignon's avatar
Romain Bignon committed
Console application to manage a Woob Repository.
Romain Bignon's avatar
Romain Bignon committed

Romain Bignon's avatar
Romain Bignon committed
.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
\fBbuild\fR \fISOURCE\fR \fIREPOSITORY\fR
.br
Build backends contained in SOURCE to REPOSITORY.
.br

.br
Example:
.br
$ woob repos build $HOME/src/woob/modules /var/www/updates.woob.tech/0.a/
Romain Bignon's avatar
Romain Bignon committed
.TP
\fBcreate\fR \fINAME\fR [\fIPATH\fR]
.br
Create a new repository. If PATH is missing, create repository
.br
on the current directory.
Romain Bignon's avatar
Romain Bignon committed
.TP
\fBdebug\fR
.br
Launch a debug Python shell
Romain Bignon's avatar
Romain Bignon committed

.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,
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 woob bank ls \-\-condition 'label=Livret A'
Florent's avatar
Florent committed
.fi
Display only the "Livret A" account.
.PP
.nf
.B woob bank ls \-\-condition 'balance>10000'
Florent's avatar
Florent committed
.fi
Display accounts with a lot of money.
.PP
.nf
.B woob bank history account@backend \-\-condition 'label|rewe'
Florent's avatar
Florent committed
.fi
Get transactions containing "rewe".
.PP
.nf
.B woob bank 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 woob bank history account@backend \-\-condition 'date>2013\-12\-01  LIMIT 10'
Florent's avatar
Florent committed
.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
Copyright(C) 2012-2021 Romain Bignon
Romain Bignon's avatar
Romain Bignon committed
.LP
For full copyright information see the COPYING file in the woob package.
Romain Bignon's avatar
Romain Bignon committed
.LP
.RE
.SH FILES
"~/.config/woob/backends" 
Romain Bignon's avatar
Romain Bignon committed

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