Skip to content

Interface & Plugins

Customize and secure your desktop experience with these commands.

FunctionCommandDescription
Lock Screen lockScreen lock Lock your screen
Idle Inhibit idleInhibitor toggle Toggle idle inhibitor
Enable Inhibit idleInhibitor enable Enable idle inhibitor
Disable Inhibit idleInhibitor disable Disable idle inhibitor
FunctionCommandDescription
History notifications toggleHistory View past notifications
Get History notifications getHistory Get history as JSON
Do Not Disturb notifications toggleDND Toggle silence mode
Enable DND notifications enableDND Enable silence mode
Disable DND notifications disableDND Disable silence mode
Clear All notifications clear Clear notification history
Remove Oldest notifications removeOldestHistory Remove oldest from history
Remove ID notifications removeFromHistory $id Remove notification by ID
Dismiss Oldest notifications dismissOldest Dismiss oldest active
Dismiss All notifications dismissAll Dismiss active notifications
FunctionCommandDescription
Send Toast toast send '$json' Display a toast notification

The toast send command accepts a JSON object with the following fields:

FieldTypeRequiredDescription
titlestringYesToast title
bodystringNoToast body/description
iconstringNoIcon name (only for notice type)
typestringNonotice (default), warning, or error
durationnumberNoDuration in ms (defaults: notice=3000, warning=4000, error=6000)

Examples:

Terminal window
# Simple notice
qs -c noctalia-shell ipc call toast send '{"title": "Recording", "body": "Started (AV1 HDR)", "icon": "media-record"}'
# Warning toast
qs -c noctalia-shell ipc call toast send '{"title": "Low battery", "type": "warning"}'
# Error with custom duration
qs -c noctalia-shell ipc call toast send '{"title": "Connection failed", "body": "Check your network", "type": "error", "duration": 10000}'
FunctionCommandDescription
Toggle Bar bar toggle Toggle bar visibility
Show Bar bar show Show bar
Hide Bar bar hide Hide bar
Toggle Dock dock toggle Toggle dock visibility
Show Widgets desktopWidgets enable Enable desktop widgets
Hide Widgets desktopWidgets disable Disable desktop widgets
Toggle Widgets desktopWidgets toggle Toggle desktop widgets
Edit Widgets desktopWidgets edit Toggle widget editing
FunctionCommandDescription
Dark Mode darkMode toggle Toggle system theme
Set Dark darkMode setDark Force dark theme
Set Light darkMode setLight Force light theme
Color Scheme colorScheme set <theme> Set scheme by name
FunctionCommandDescription
Selector wallpaper toggle Toggle wallpaper selector
Set Wallpaper wallpaper set $path $monitor Set wallpaper on monitor
Random wallpaper random Apply random wallpaper
Toggle Auto wallpaper toggleAutomation Toggle automation
Enable Auto wallpaper enableAutomation Enable automation
Disable Auto wallpaper disableAutomation Disable automation
FunctionCommandDescription
Settings plugin openSettings $pluginId Open plugin settings
Open Panel plugin openPanel $pluginId Open plugin panel
Close Panel plugin closePanel $pluginId Close plugin panel
Toggle Panel plugin togglePanel $pluginId Toggle plugin panel
FunctionCommandDescription
State state all Output settings state
Set Location location set $name Set geographic location
Get Location location get Get geographic location