ggg run

ggg run [--with-export-templates] [--godot <path>] [<godot-args>...]

Runs the current project using the Godot version declared in ggg.toml. If that version is not yet cached, it is downloaded first. A different executable can be supplied with --godot or GGG_GODOT_EXECUTABLE instead.

Unlike ggg edit, this launches Godot in game mode rather than opening the editor. Use it to run your project from the terminal, for example in a CI environment or to quickly test without opening the full editor.

Usage

ggg run

Run this from your project directory. ggg flags must come before any Godot arguments. Any arguments after the ggg flags are forwarded verbatim to Godot:

ggg run --headless
ggg run --headless --script res://tests/run_tests.gd
ggg run --with-export-templates --headless

Flags

--with-export-templates: download and install export templates for the declared Godot version before running, regardless of the export_templates setting in ggg.toml. Does not modify ggg.toml.

If export_templates = true is set in ggg.toml, templates are always ensured without needing this flag.

--godot <path>: use the Godot executable at <path> instead of the managed version declared in ggg.toml. No engine is downloaded or cached. The path must exist and be a regular file, otherwise ggg run fails with an error naming the flag. When this flag is set it takes precedence over the GGG_GODOT_EXECUTABLE environment variable.

Notes

• Requires a ggg.toml in the current directory.
• Downloads and caches the declared Godot version on first run. Subsequent runs start immediately from the cache. (Without a --godot flag or GGG_GODOT_EXECUTABLE override.)
• Does not run ggg sync first. If you have just added or updated dependencies, run ggg sync beforehand.

See also

• ggg edit: opens the project in the Godot editor instead
• ggg sync: installs dependencies before running