Skip to content

instantWM

instantWM is instantOS's hybrid window manager and Wayland compositor. The same core window-management behavior is available through its X11 and Wayland backends: persistent manual tiling, first-class floating windows, tags, scratchpads, an interactive bar, custom keybindings and modes, and a runtime IPC command.

Start here

Special window behavior

Customize instantWM

  • instantWM configuration documents config.toml, themes, inputs, monitors, keybindings, and layout geometry.
  • Environment variables covers WAYLAND_DISPLAY/DISPLAY backend auto-detection, INSTANTWM_LOG, INSTANTWM_SOCKET, INSTANTWM_AUTOSTART, XKB_*/XCURSOR_* fallbacks and the variables instantWM exports for children. The CLI flag instantwm --backend x11|nested|drm overrides the display-variable detection.
  • Modes explains custom modes and the built-in keyboard placement mode.
  • instantwmctl is the runtime IPC reference.
  • Visibility options covers the bar, tag labels, and empty tags.
  • Screenshots, notifications, and screen locking document desktop integrations commonly used from instantWM bindings.

Scripting and development

  • Modes explains how to create contextual groups of keybindings.
  • instantwmctl is the command-line and IPC reference for scripts and integrations.

The compiled defaults are always available locally with instantwm --print-config and instantwm --list-actions. Those commands are the best reference when a custom package or local build differs from the instantOS defaults documented here.