Files
Frank b441cfda56 docs(DE): full redesign sweep — desk profiles, keybinds, noctalia v5, handy fleet wiring, incident log
- niri: index/config-tree rework, displays.md desk-profile rewrite,
  tips/action-reference/default-bindings refresh (26.04),
  generated keybindings.md (119 bindings)
- noctalia-shell.md: settings.toml lives in ~/.local/state, taskbar
  widget, v5 keybind table (Mod+D/Mod+V/Alt+Tab)
- handy.md: NEW; live nested store shape, fleet endpoint, known
  thinking-model empty-content breaker + verified cure
- log.md: DE redesign entry + pam_faillock sudo-lockout incident
2026-10-09 14:42:08 -07:00

108 lines
4.7 KiB
Markdown

---
type: reference
title: Niri Action Reference
description: Curated reference of niri actions — window operations, focus, movement, spawning, and system actions. For complete command-line options, see `niri msg action <ACTION> --help`.
tags:
- niri
- actions
- reference
verified: 2026-10-09
---
# Action Reference
> **Note:** This is a curated subset. For complete options and parameters, run `niri msg action <ACTION> --help` (authoritative, live).
## Window/Column Actions
- `close-window` — Close focused window
- `toggle-window-floating` — Toggle floating/tiling
- `maximize-column` — Maximize column with gaps
- `maximize-window-to-edges` — Maximize without gaps
- `expand-column-to-available-width` — Fill remaining space
- `center-column` — Center focused column
- `center-visible-columns` — Center all visible columns
- `switch-preset-column-width` — Cycle preset widths
- `switch-preset-column-width-back` — Cycle backwards
- `switch-preset-window-height` — Cycle preset heights
- `reset-window-height` — Reset height
- `toggle-column-tabbed-display` — Toggle vertical tabs mode
- `consume-or-expel-window-left/right` — Consume/expel window
- `consume-window-into-column` — Consume window into column
- `expel-window-from-column` — Expel window from column
- `set-column-width "-10%"` / `set-column-width "+10%"` — Fine width adjustment
- `set-window-height "-10%"` / `set-window-height "+10%"` — Fine height adjustment
## Focus Actions
- `focus-column-left/right` — Focus adjacent column
- `focus-window-up/down` — Focus window within column
- `focus-column-first/last` — Focus first/last column
- `focus-workspace N` — Focus workspace N
- `focus-workspace-down/up` — Focus next/previous workspace
- `focus-workspace-previous` — Focus previously active workspace
- `focus-monitor-left/right/up/down` — Focus adjacent monitor
## Move Actions
- `move-column-left/right` — Move column left/right
- `move-window-up/down` — Move window within column
- `move-column-to-first/last` — Move column to edge
- `move-column-to-workspace-down/up` — Move column to adjacent workspace
- `move-column-to-workspace N` — Move column to workspace N
- `move-column-to-monitor-left/right/up/down` — Move column to adjacent monitor
## Other Actions
- `spawn "program"` — Run program (no shell expansion)
- `spawn-sh "command"` — Run command through shell
- `spawn-at-startup "program"` — Run at startup
- `quit` — Quit compositor (with confirmation, `--skip-confirmation` available)
- `show-hotkey-overlay` — Show keybind cheat sheet
- `toggle-overview` — Toggle overview
- `screenshot` — Interactive screenshot
- `screenshot-screen` — Screenshot monitor (`--write-to-disk`, `--show-pointer` options)
- `screenshot-window` — Screenshot window (`--write-to-disk`, `--show-pointer` options)
- `power-off-monitors` — Turn off displays
- `toggle-keyboard-shortcuts-inhibit` — Toggle inhibitor
- `do-screen-transition` — Smooth screen transition (for theme switching, `--delay-ms` option)
- `stop-cast --session-id <ID>` — Stop a PipeWire screencast
- `toggle-window-rule-opacity` — Toggle opacity of focused window
- `focus-column-or-monitor-left/right` — Focus column or monitor horizontally
- `focus-column-or-monitor-up/down` — Focus column or monitor vertically
- `focus-window-or-monitor-up/down` — Focus window or monitor vertically
- `focus-window-or-monitor-down/up` — Focus window or monitor vertically
- `focus-column-or-monitor-left/right` — Focus column or monitor horizontally
- `focus-window-or-monitor-down/up` — Focus window or monitor vertically
- `focus-window-or-workspace-down/up` — Focus window or workspace vertically
- `focus-window-or-workspace-up/down` — Focus window or workspace vertically
## Bind Properties
Actions and bindings support optional properties:
| Property | Description |
|----------|-------------|
| `repeat=false` | Disable repeat for the binding |
| `cooldown-ms=N` | Rate-limit to N milliseconds (commonly 150 for wheel binds) |
| `allow-when-locked=true` | Execute even when session is locked |
| `allow-inhibiting=false` | Process even when inhibitor is active |
| `hotkey-overlay-title="..."` | Custom title for overlay (supports `=null` to hide or Pango markup) |
### Mod+Mouse* Binds (25.01+)
Since 25.01, `Mod+Mouse*` binds are supported for advanced navigation.
### TouchpadScroll Binds
`Mod+TouchpadScroll*` binds are available for touchpad-based navigation.
### Mouse-Click Binds
Mouse-click actions operate on the **focused window**, not the clicked window.
## Related
* [Default Bindings](/tools/niri/default-bindings.md) — Default key bindings that invoke these actions
* [Tips](/tools/niri/tips.md) — Programmatic invocation and other tips