Running GRASS Modules
:::caution Last revised 2026-05-01 — not re-verified
This page has not been checked against the running system since it was
written, and predates a large part of the current product. It is scheduled
for rewrite. For anything about the API, /docs on a running server is
authoritative.
:::
The Run Module panel lets you execute any GRASS GIS module interactively.
Workflow
- Type a module name in the input field (e.g.
r.slope.aspect) — autocomplete suggests matches as you type - Click Load ↓ to fetch the module schema and generate the input form
- Fill in the parameters
- Review the Command preview line at the bottom
- Click ▶ Run
Autocomplete
The module input supports fuzzy autocomplete over all modules available in the current GRASS environment. Press ↓ to open the dropdown, Enter to select.
Module form
Each parameter in the module schema is rendered as:
| Parameter type | Control |
|---|---|
| String / name | Text input |
| Number | Number input |
| Boolean flag | Checkbox |
| Map name (raster/vector) | Dropdown populated from g.list |
| Multiple values | Multi-select |
Required parameters are marked with a *.
Command preview
The preview line below the form shows the exact command that will be sent to the server, including all flags and key=value pairs. It updates live as you change inputs.
Running and output
Click ▶ Run to submit. The button disables and the ■ Cancel button activates.
- Output streams line-by-line to the Terminal tab in real time (SSE)
- The status badge in the top-right toggles between RUNNING and IDLE
- When the module finishes, the task id is logged and the job appears in the Jobs tab
Cancelling
Click ■ Cancel while a module is running to send a kill signal to the subprocess.
History
Completed runs appear in the History section at the bottom of the left panel. Click any entry to re-populate the form with the same module and arguments.