[GNC] Command Line Report Options

[Christopher Lam]

Hi Robin

The documentation is not comprehensive yet. The export-type argument refers
to the *report-specific* export types available, rather than PDF/XLS/DOC
etc. Report-specific exports are rather sparse; currently only the
following exist:

Income and GST Statement: CSV
Tax Schedule Report & TXF Export: TXF
Tax Report & XML Export (in German only): XML

To export "Income and GST Statement" CSV, you'd need to customize the
report options, save into "Saved Report Configurations" eg. "My GST", then
run as follows. I cannot assist with the tax reports.

$ gnucash-cli --report run --name "My GST" --export-type CSV --output-file
gst.csv datafile.gnucash

outputs the following into gst.csv

"from","01/04/20"
"to","30/06/20"
"Gross Sales",220.0
"Net Sales",200.0
"Tax on Sales",20.0
"Gross Purchases",110.0
"Net Purchases",100.0
"Tax on Purchases",10.0

On Sat, 18 Jul 2020 at 02:52, Robin Chattopadhyay <robinraymn at gmail.com>
wrote:

> In the release notes and the help page, the documentation lists
> 'export-type' as an option and the example cites html as an export type
> option. Are there any other supported options? I tried 'pdf' and 'PDF' and
> neither of those worked.
>
> From the release notes:
>         • A new separate executable, gnucash-cli (gnucash-cli.exe on
> Microsoft Windows) for doing command-line things like updating the prices
> in your book. gnucash-cli gains the ability to run reports from the command
> line. Specify reports to run by name or guid. It also provides an export
> format and an output file name without which it will output the report to
> stdout.
>                 • gnucash-cli --report run --name=[reportname/guid]
> datafile.gnucash
>                 • gnucash-cli --report run --name=[reportname/guid]
> --output-file=x.html datafile.gnucash
>                 • gnucash-cli --report run --name=[reportname/guid]
> --output-file=x.html --export-type=TYPE datafile.gnucash
>
> Thanks,
> Robin
> _______________________________________________
> gnucash-user mailing list
> gnucash-user at gnucash.org
> To update your subscription preferences or to unsubscribe:
> https://lists.gnucash.org/mailman/listinfo/gnucash-user
> If you are using Nabble or Gmane, please see
> https://wiki.gnucash.org/wiki/Mailing_Lists for more information.
> -----
> Please remember to CC this list on all your replies.
> You can do this by using Reply-To-List or Reply-All.
>