Customize and secure your desktop experience with these commands.

Security & Privacy

Function Command Description
Lock Screen ipc call lockScreen lock Lock your screen
Idle Inhibit ipc call idleInhibitor toggle Toggle idle inhibitor
Enable Inhibit ipc call idleInhibitor enable Enable idle inhibitor
Disable Inhibit ipc call idleInhibitor disable Disable idle inhibitor
Airplane Mode ipc call airplaneMode toggle Toggle airplane mode
Enable Airplane Mode ipc call airplaneMode enable Enable airplane mode (disables Wi-Fi & Bluetooth)
Disable Airplane Mode ipc call airplaneMode disable Disable airplane mode

Notifications

Function Command Description
History ipc call notifications toggleHistory View past notifications
Get History ipc call notifications getHistory Get history as JSON
Do Not Disturb ipc call notifications toggleDND Toggle silence mode
Enable DND ipc call notifications enableDND Enable silence mode
Disable DND ipc call notifications disableDND Disable silence mode
Clear All ipc call notifications clear Clear notification history
Remove Oldest ipc call notifications removeOldestHistory Remove oldest from history
Remove ID ipc call notifications removeFromHistory $id Remove notification by ID
Dismiss Oldest ipc call notifications dismissOldest Dismiss oldest active
Dismiss All ipc call notifications dismissAll Dismiss active notifications

Toast Notifications

Function Command Description
Send ipc call toast send '$json' Display a toast notification
Dismiss ipc call toast dismiss Dismiss active toast notification

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

Field Type Required Description
title string Yes Toast title
body string No Toast body/description
icon string No Icon name (only for notice type)
type string No notice (default), warning, or error
duration number No Duration in ms (defaults: notice=3000, warning=4000, error=6000)

Examples:

# 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}'

Appearance

Visibility

Function Command Description
Toggle Bar ipc call bar toggle Toggle bar visibility
Show Bar ipc call bar showBar Show bar
Hide Bar ipc call bar hideBar Hide bar
Peek Bar ipc call bar peek Briefly show bar, then auto-hide
Bar DisplayMode ipc call bar setDisplayMode <mode> <screen> Set bar display mode
Bar Position ipc call bar setPosition <position> <screen> Set bar position
Toggle Dock ipc call dock toggle Toggle dock visibility
Show Widgets ipc call desktopWidgets enable Enable desktop widgets
Hide Widgets ipc call desktopWidgets disable Disable desktop widgets
Toggle Widgets ipc call desktopWidgets toggle Toggle desktop widgets
Edit Widgets ipc call desktopWidgets edit Toggle widget editing

Available Bar Display Modes

  • always_visible
  • non_exclusive
  • auto_hide

<screen>: Monitor identifier (e.g., HDMI-A-1), or use an empty string or all to set mode on all monitors.

Available Bar Positions

  • top
  • bottom
  • left
  • right

<screen>: Monitor identifier (e.g., HDMI-A-1). Use an empty string or all to set position on all monitors.

Theme Controls

Function Command Description
Dark Mode ipc call darkMode toggle Toggle system theme
Set Dark ipc call darkMode setDark Force dark theme
Set Light ipc call darkMode setLight Force light theme
Color Scheme ipc call colorScheme set <theme> Set scheme by name
Set Method ipc call colorScheme setGenerationMethod <method> Set color generation method

Available Generation Methods

  • tonal-spot
  • content
  • fruit-salad
  • rainbow
  • monochrome
  • vibrant
  • faithful
  • dysfunctional
  • muted

Wallpaper Management

Function Command Description
Selector ipc call wallpaper toggle Toggle wallpaper selector
Get Wallpaper ipc call wallpaper get $monitor Get path to wallpaper on monitor
Set Wallpaper ipc call wallpaper set $path $monitor Set wallpaper on monitor
Random ipc call wallpaper random $monitor Apply random wallpaper (omit monitor for all)
Toggle Auto ipc call wallpaper toggleAutomation Toggle automation
Enable Auto ipc call wallpaper enableAutomation Enable automation
Disable Auto ipc call wallpaper disableAutomation Disable automation
Refresh List ipc call wallpaper refresh Refresh wallpapers list

Wallpaper variables

  • $path: Full path to your wallpaper image file
  • $monitor: Monitor identifier (e.g., HDMI-A-1). Use an empty string or all to apply to all monitors.

Plugin Controls

Function Command Description
Settings ipc call plugin openSettings $pluginId Open plugin settings
Open Panel ipc call plugin openPanel $pluginId Open plugin panel
Close Panel ipc call plugin closePanel $pluginId Close plugin panel
Toggle Panel ipc call plugin togglePanel $pluginId Toggle plugin panel

Plugin ID Replace $pluginId with the actual plugin identifier (e.g., todo, pomodoro).

Misc

Function Command Description
State ipc call state all Output settings state
Set Location ipc call location set $name Set geographic location
Get Location ipc call location get Get geographic location

This site uses Just the Docs, a documentation theme for Jekyll.