Command Line Interface

Qgoda options, commands and command options

Qgoda is a command-line program.

Table Of Contents

General Usage

The general usage pattern for qgoda is:

$ qgoda [GLOBAL_OPTIONS] [COMMAND, [OPTIONS]]

For example:

$ qgoda --verbose build --drafts --future

That sets the global option --verbose to true and selects the qgoda command build with the options --drafts and --future.

Global Options

Qgoda currently supports the following global options.

-q, --quiet
Activates quiet mode. In quiet mode, only errors and fatal errors are displayed.
-v, --verbose
Enables verbose logging. A lot more details are displayed. You will normally select verbose mode only, when tracking down errors.
--log-stderr
Causes qgoda to log to standard error instead of standard output.
-h, --help
Causes qgoda to display usage information and exit immediately. All other options and commands are ignored.
-V, --verbose
Causes qgoda to display version information and exit immediately. All other options and commands are ignored.

Commands

The next token on the command-line must be one of the supported commands, currently build, watch, config, init, dump, markdown, xgettext, and po.

Command Options and Arguments

The rest of the command-line are options specific to the selected command. Try qgoda COMMAND --help for help for the specific command (replace COMMAND with one of the supported commands. The option -h or --help is supported by all qgoda commands.

The command help is displayed using the system pager. Hit the letter q to leave the pager. SPACE scrolls one page down, cursor-down or j scrolls one line down, cursor-up or k scrolls one line up, h shows more help.

Availabe Commands

build

The commands build instructs qgoda to build the site and exit. Helper programs are not executed!

watch

Same as build above but instead of terminating, qgoda watches the file system for changes and triggers a re-build after a source file has changed.

Helper applications are started in parallel.

config

Dumps the current configuration as YAML and exits. The configuration printed is the result of merging the default configuration with the files _config.yaml and _localconfig.yaml.

init

Initializes a new qgoda site.

dump

Dumps the content of the entire site. The output is suitable for pumping it into external programs (for example full-text search engines like elasticsearch.

markdown

Generates html from a markdown file. This is meant for debugging problems with markdown rendering.

po

Various commands needed for multi-language sites. See for details.

xgettext

Extracts translatable snippets from the site's markdown source files into .po. files. This command is invoked implicitely by qgoda po pot (see above), and you normally don't have to use qgoda xgettext directly. See for more information.