Forrest logo
back to the gnucash-cli tool

gnucash-cli:tldr:d08e7

gnucash-cli: Generate a financial report of a specific type, specified by `--name`.
$ gnucash-cli --report run --name "${Balance Sheet}" ${filename-gnucash}
try on your machine

This command is used to run a report in Gnucash using the command-line interface (CLI). Here is an explanation of each part of the command:

  • gnucash-cli: This is the command to run the CLI version of Gnucash, which allows you to interact with the Gnucash accounting software from the command line.

  • --report run: This option specifies that you want to run a report in Gnucash.

  • --name "${Balance Sheet}": This option specifies the name of the report you want to run. In this case, the report is named "Balance Sheet." Note that the report name is enclosed in double quotes and is referenced using the $ sign and curly braces to prevent shell expansion of the string.

  • ${filename-gnucash}: This specifies the filename of the Gnucash data file you want to use for generating the report. The notation ${filename-gnucash} indicates that the filename is a variable and its value will be provided when executing the command.

Overall, this command is used to run the "Balance Sheet" report in Gnucash using the CLI interface, with the Gnucash data file specified by the value of the ${filename-gnucash} variable.

This explanation was created by an AI. In most cases those are correct. But please always be careful and never run a command you are not sure if it is safe.
back to the gnucash-cli tool