gnucash-cli(1)

1GNUCASH(1)                   GnuCash Manual Pages                   GNUCASH(1)
2
3
4

NAME

6       gnucash-cli - command line tool to go with GnuCash
7

SYNOPSIS

9       gnucash-cli [options] [ accounts.gnucash ]
10

DESCRIPTION

12       gnucash-cli enables certain intraction with a gnucash datafile directly
13       from the command line.
14
15       It has two modes: quotes mode and report mode.
16
17

Quotes Mode (activated with --quotes <cmd>)

19       This mode has options to get online quotes for foreign  currencies  and
20       stocks in the given data file. It supports the following command:
21
22       info   Shows Finance::Quote version and exposed quote sources.
23
24       get    Retrieves online quotes. Note this requires Finance::Quote to be
25              properly configured for your system.
26
27              The get command takes the following options:
28
29       --namespace=REGEXP
30              Regular expression determining which namespace commodities  will
31              be retrieved.
32
33
34       dump   Fetches current quotes for specified currencies or stocks from a
35              specified namespace and print the results to the  console.  This
36              must  be  followed with a source and one or more symbols, unless
37              the source is "currency" in which case it must be followed  with
38              two or more symbols, the first of which is the currency in which
39              exchange rates for the rest will be quoted.
40
41              The dump command takes the option
42
43       -v
44
45       --verbose
46              Lists all of the parameters Finance::Quote returns for the  sym‐
47              bol instead of only the ones that Gnucash requires.
48
49

Report Mode (activated with --report <cmd>)

51       This  mode has options to work with reports in the given data file.  It
52       supports the following command:
53
54       run    Runs a report on the given data file.
55
56              The run command takes the following options:
57
58       --name=REPORT_NAME
59              Name of the report to run
60
61       --export-type=TYPE
62              Specify export type
63

General Options

65       --version
66              Show GnuCash version
67
68       --help Show this help message
69
70       --debug
71              Enable debugging mode: increasing logging to  provide  deep  de‐
72              tail.
73
74       --extra
75              Enable extra/development/debugging features.
76
77       --log  Log    level   overrides,   of   the   form   "log.ger.path={de‐
78              bug,info,warn,crit,error}" This option can be specified multiple
79              times.
80
81       --logto
82              File  to  log  into;  defaults  to  "$TMPDIR/gnucash.trace"; use
83              "stderr" or "stdout" to write to the terminal.
84

FILES

86       ~/.gnucash/config.auto
87              Automatically generated per-user  configuration  file.   DO  NOT
88              EDIT MANUALLY!
89

ENVIRONMENT

91       GNC_DEBUG
92              Enable  debugging output.  This allows you to turn on the debug‐
93              ging earlier in the startup process than you can with --debug.
94
95       GUILE_LOAD_PATH
96              An override for the GnuCash scheme load path. You shouldn't need
97              to alter this.  For more information see the README file.
98
99       GNC_MODULE_PATH
100              An  override  for  the GnuCash scheme load path for Gnucash mod‐
101              ules. You shouldn't need to alter this.   For  more  information
102              see the README file.
103

BUGS

105       Please  report any bugs using the bug reporting form on the GnuCash web
106       site.
107
108

AUTHOR

117       Robert Merkel <rgmerk@mira.net> wrote this manpage.
118
119       GnuCash  was written by Robin Clark, Linas Vepstas, and a cast of thou‐
120       sands.
121
122
123
124Version 5.3-412-g53245caebf+      2023-09-23                        GNUCASH(1)