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       get    Retrieves online quotes. Note this requires Finance::Quote to be
23              properly configured for your system.
24
25              The get command takes the following options:
26
27       --namespace=REGEXP
28              Regular expression determining which namespace commodities  will
29              be retrieved.
30

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

32       This  mode has options to work with reports in the given data file.  It
33       supports the following command:
34
35       run    Runs a report on the given data file.
36
37              The run command takes the following options:
38
39       --name=REPORT_NAME
40              Name of the report to run
41
42       --export-type=TYPE
43              Specify export type
44

General Options

46       --version
47              Show GnuCash version
48
49       --help Show this help message
50
51       --debug
52              Enable debugging mode: increasing logging to  provide  deep  de‐
53              tail.
54
55       --extra
56              Enable extra/development/debugging features.
57
58       --log  Log    level   overrides,   of   the   form   "log.ger.path={de‐
59              bug,info,warn,crit,error}" This option can be specified multiple
60              times.
61
62       --logto
63              File  to  log  into;  defaults  to  "/tmp/gnucash.trace"; can be
64              "stderr" or "stdout".
65

FILES

67       ~/.gnucash/config.auto
68              Automatically generated per-user  configuration  file.   DO  NOT
69              EDIT MANUALLY!
70

ENVIRONMENT

72       GNC_DEBUG
73              Enable  debugging output.  This allows you to turn on the debug‐
74              ging earlier in the startup process than you can with --debug.
75
76       GUILE_LOAD_PATH
77              An override for the GnuCash scheme load path. You shouldn't need
78              to alter this.  For more information see the README file.
79
80       GNC_MODULE_PATH
81              An  override  for  the GnuCash scheme load path for Gnucash mod‐
82              ules. You shouldn't need to alter this.   For  more  information
83              see the README file.
84

BUGS

86       Please  report any bugs using the bug reporting form on the GnuCash web
87       site.
88
89

AUTHOR

98       Robert Merkel <rgmerk@mira.net> wrote this manpage.
99
100       GnuCash  was written by Robin Clark, Linas Vepstas, and a cast of thou‐
101       sands.
102
103
104
105Version 4.13+                     2022-12-17                        GNUCASH(1)