g.gui(1)

πŸ¦‹ g.gui β€” the GRASS GIS User's Manual, but make it a group chat πŸ¦‹

okay bestie, so this is g.gui(1) from the GRASS GIS User's Manual and it's literally the door to the whole GUI situation. come sit, this is gonna be fun πŸ’–


✨ NAME ✨

g.gui β€” launches a GRASS graphical user interface (GUI) session. and like, optionally it also updates your default user interface settings. so it's giving two-jobs-one-command energy πŸ‘‘


🌸 KEYWORDS 🌸

general, GUI, user interface


πŸŽ€ SYNOPSIS πŸŽ€

g.gui
g.gui --help
g.gui [-fdn]  [ui=string]   [workspace=name.gxw]   [--help]  [--verbose]
[--quiet]  [--ui]

🫢 Flags

  • -f β€” Start GUI in the foreground. by default the GUI starts in the background and control comes right back to whoever called it, like "k bye". but when the GUI runs in the foreground, it blocks the command line 😭 so you're just sitting there waiting, respectfully
  • -d β€” Update default user interface settings ✨
  • -n β€” Do not launch GUI after updating the default user interface settings. so you change the settings and then dip, no GUI, no drama πŸ’…
  • --help β€” Print usage summary
  • --verbose β€” Verbose module output
  • --quiet β€” Quiet module output
  • --ui β€” Force launching GUI dialog

🌈 Parameters

  • ui=string β€” User interface
    • Options: wxpython, text, gtext
    • Default: wxpython
    • wxpython: wxPython based GUI (wxGUI)
    • text: command line interface only
    • gtext: command line interface with GUI startup screen
  • workspace=name.gxw β€” Name of workspace file to load on start-up. this is valid only for wxGUI (wxpython), so don't try it anywhere else bestie, iykyk πŸ™ˆ

πŸ’œ DESCRIPTION πŸ’œ

So the g.gui module lets you start the Graphical User Interface (GUI) straight from the command line prompt, or change your default User Interface (UI) settings. both. iconic.

GRASS GIS comes with both a wxPython-based GUI (aka wxGUI, ui=wxpython) and a command line text-based UI (ui=text). pick your fighter πŸ₯Š


⭐ NOTES ⭐

okay pay attention because this part actually matters:

If the -d update flag is given, or if the GRASS_GUI environmental variable is unset, then the GRASS internal variable GUI is permanently changed and the selected ui will be used as the default UI from then on. permanent. no take-backsies 🫢

All GRASS internal variables (see g.gisenv) are stored in your user's home directory in a hidden file called $HOME/.grass8/rc on Unix-based operating systems, and %APPDATA%\GRASS8\rc on MS Windows.

⚠️ heads up: these GRASS internal variables are not the shell environment variables, and the rc file is not a classic UNIX run command file β€” it just contains persistent GRASS variables. do not confuse them, bestie, it's giving trap πŸ’€

🧚 EXAMPLES 🧚

Set default user interface settings

Set default user interface setting to command line, text-based UI:

g.gui -d ui=text

Set default user interface setting to the graphical user interface (GUI) and launch the GUI:

g.gui -d ui=wxpython

Set default user interface setting to the graphical user interface (GUI) but do not launch the GUI:

g.gui -dn ui=wxpython

Load workspace from command line

Start the GUI from command line with an existing workspace:

g.gui workspace=myproject.gxw

πŸ‘‘ SEE ALSO πŸ‘‘

  • wxGUI
  • g.gisenv
  • GRASS variables
  • wxGUI wiki page

πŸ’– AUTHORS πŸ’–

  • Martin Landa, FBK-irst, Trento, Italy
  • Hamish Bowman, Otago University, Dunedin, New Zealand (fine tuning)

πŸ”₯ SOURCE CODE πŸ”₯

Available at: g.gui source code (history)

Accessed: Saturday Jan 17 05:40:39 2026

Main index | General index | Topics index | Keywords index | Graphical index | Full index


Β© 2003-2025 GRASS Development Team, GRASS GIS 8.4.2 Reference Manual


and that's the whole thing bestie πŸŽ€ this page lives in GRASS 8.4.2 (that's the version, she's serving), and the source code was peeked at on Saturday Jan 17 05:40:39 2026, under the Β© 2003-2025 GRASS Development Team, GRASS GIS 8.4.2 Reference Manual copyright. go launch something cute, slay, periodt πŸ’…βœ¨

πŸ“¦ where this page comes from