Choose Settings → Appearance → Template → Gantry CLI. Type help in the field at the bottom and press Enter. The same 25 commands work in the macOS, Windows and Linux apps. The web dashboard retains shortcut buttons.
Polish and English aliases work regardless of the interface language. Matching ignores letter case and Polish accents. You can use X1 pause instead of pause X1. A printer name alone, such as X1, opens details. Exact names and serial numbers take priority; a prefix works only when it identifies one printer. Names with spaces can be quoted: edit "Office Printer".
Available commands
| Command | Action |
|---|---|
help [command] | Commands and usage. |
clear | Clear terminal output. |
printers | List printers and states. |
status [printer] | State, progress and remaining time. |
history [1–30] | Recent recorded prints. |
spools [search text] | Open inventory or search rolls. |
vision | Open camera monitoring. |
costs | Open statistics and costs. |
settings | Open settings. |
ams | Open printer materials. |
service [printer] | Open maintenance and service. |
diagnostics | Open diagnostics. |
farm | Open Farm when enabled. |
printer <name> | Open printer details. |
edit <printer> | Edit a printer. |
add | Add a printer. |
columns 1\|2 | Change column count. |
scale 50–150 | Size in five-percent steps. |
theme light\|dark | Change light or dark appearance. |
refresh [printer] | Reconnect one printer or all. |
pause <printer> | Request pause of a printing device. |
resume <printer> | Resume a paused device. |
light on\|off [printer\|all] | Lighting of supported printers. |
ip <printer> | Show printer address. |
version | Show Gantry version. |
Square brackets [ ] mark optional arguments. history shows 5 entries by default, up to 30. spools PLA searches physical rolls in the active Spoolbase or Spoolman inventory; without an argument it opens inventory. Unknown weight is shown as — g. Search output is limited to 20 rows.
Input and replies
- Enter — run a command.
- ↑ / ↓ — browse successful commands while preserving your unfinished draft. History holds 30 entries and stays in application memory only.
- Tab — complete a command or printer name; show suggestions when several match.
- Escape — clear input and output. The next Escape retains the window’s normal behavior.
help pause— show one command’s usage;clearclears terminal output only.
Replies can be selected and copied. Long results scroll within a bounded output area.
Controls and availability
pause only works for a printing device; resume requires a paused device. light off requests all available devices supporting lighting; light off X1 selects one. Offline devices and monitoring-only integrations receive no control requests. The reply confirms that a request was sent; updated printer state arrives separately through telemetry.
Farm and inventory respect their feature switches. Commands do not enable disabled modules. This field handles Gantry actions; it never launches a system shell, scripts or arbitrary G-code.