GNUCASH(1)

📦
version 5.17 · 12 versions
, in fedora 43, fedora 44, nixpkgs unstable

💖 GNUCASH(1) 💖

okay bestie, so this is the GnuCash Manual Pages page for gnucash-cli — the little command-line bestie that hangs out with GnuCash. i'm gonna walk you through it like we're texting at 2am, but every single flag and file path stays exactly where it is. no cap. 🫶

✨ NAME ✨

gnucash-cli — a command line tool to go with GnuCash 🎀

✨ SYNOPSIS ✨

gnucash-cli [options] [ accounts.gnucash ]

✨ DESCRIPTION ✨

so gnucash-cli lets you do certain kinds of interaction with a gnucash datafile directly from the command line. it's giving very "i don't need the GUI today" energy. 💅

it has two modes: quotes mode and report mode. periodt.

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

this mode has options to get online quotes for foreign currencies and stocks in the given data file. it supports the following command:

  • info — Shows Finance::Quote version and exposed quote sources. lowkey just a lil vibe check on your quote sources. ✨
  • get — Retrieves online quotes. 👑 note this requires Finance::Quote to be properly configured for your system, so like... set it up first bestie.

the get command takes the following options:

  • --namespace=REGEXP — a regular expression determining which namespace commodities will be retrieved.
  • dump — Fetches current quotes for specified currencies or stocks from a specified namespace and print the results to the console. 🖨️ this must be followed with a source and one or more symbols, unless the source is "currency", in which case it must be followed with two or more symbols — the first of which is the currency in which exchange rates for the rest will be quoted.

the dump command takes the option:

  • -v
  • --verbose — Lists all of the parameters Finance::Quote returns for the symbol instead of only the ones that Gnucash requires. the way that it just dumps the whole thing... 💀

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

this mode has options to work with reports in the given data file. it supports the following command:

  • run — Runs a report on the given data file. go bestie, run it 🏃♀️✨

the run command takes the following options:

  • --name=REPORT_NAME — Name of the report to run
  • --export-type=TYPE — Specify export type

🌸 General Options 🌸

  • --version — Show GnuCash version 🌈
  • --help — Show this help message
  • --debug — Enable debugging mode: increasing logging to provide deep detail. it's giving detective era 🔍
  • --extra — Enable extra/development/debugging features.
  • --log — Log level overrides, of the form "log.ger.path={debug,info,warn,crit,error}". This option can be specified multiple times. yes, multiple times, stack 'em 💅
  • --logto — File to log into; defaults to "$TMPDIR/gnucash.trace"; use "stderr" or "stdout" to write to the terminal.

✨ FILES ✨

  • ~/.gnucash/config.auto — Automatically generated per-user configuration file. DO NOT EDIT MANUALLY! 🚨
okay this is the one i'm serious about. that file is auto-generated. hands off. the computer made it, let the computer keep it. 🙈

✨ ENVIRONMENT ✨

  • GNC_DEBUG — Enable debugging output. This allows you to turn on the debugging earlier in the startup process than you can with --debug. so like, early access debugging 👑
  • GUILE_LOAD_PATH — An override for the GnuCash scheme load path. You shouldn't need to alter this. For more information see the README file.
  • GNC_MODULE_PATH — An override for the GnuCash scheme load path for Gnucash modules. You shouldn't need to alter this. For more information see the README file.
ngl if you're messing with GUILE_LOAD_PATH or GNC_MODULE_PATH you're in your main character era but you should probably not be. leave them alone bestie 🫶

✨ BUGS ✨

Please report any bugs using the bug reporting form on the GnuCash web site. 🐛 if you found one, you're literally doing the community a service. slay.

✨ SEE ALSO ✨

  • GnuCash has extensive on-line help available from the "help" menu.
  • Additional information and the latest version is available at the web site: https://www.gnucash.org 🌈

✨ AUTHOR ✨

Robert Merkel <rgmerk@mira.net> wrote this manpage. 🎀

GnuCash was written by Robin Clark, Linas Vepstas, and a cast of thousands. a whole cast, iconic behavior honestly 👑

and that's the whole thing, bestie!! 💖✨ this was Version 5.17+, dated 2026-09-26, straight from the GnuCash Manual Pages. go forth and quote your currencies, you absolute icon 🦋💅

📦 where this page comes from