Skip to content

Configuration commands

Source version: main.

Configuration management commands. All commands act on the running Rift instance.

Changes apply immediately. Run rift-cli execute config save to persist them to the active config path. Saving preserves unrelated TOML comments, formatting, ordering, and source keybindings, and replaces the file atomically. get displays normalized runtime values; reload reads the file again. See Configuration for the save and reload workflow.

Update animation settings.

Synopsis
rift-cli execute config set-animate <VALUE>

Arguments

<VALUE>

Set the animation duration in seconds.

Synopsis
rift-cli execute config set-animation-duration <VALUE>

Arguments

<VALUE>

Set the animation frame rate.

Synopsis
rift-cli execute config set-animation-fps <VALUE>

Arguments

<VALUE>

Set the animation easing curve.

Synopsis
rift-cli execute config set-animation-easing <VALUE>

Arguments

<VALUE>

Update mouse settings.

Synopsis
rift-cli execute config set-mouse-follows-focus <VALUE>

Arguments

<VALUE>
Accepted values: true, false.

Show or hide the pointer after focus changes.

Synopsis
rift-cli execute config set-mouse-hides-on-focus <VALUE>

Arguments

<VALUE>
Accepted values: true, false.

Enable or disable focusing windows under the pointer.

Synopsis
rift-cli execute config set-focus-follows-mouse <VALUE>

Arguments

<VALUE>
Accepted values: true, false.

Update layout settings.

Synopsis
rift-cli execute config set-stack-offset <VALUE>

Arguments

<VALUE>

Set the default stack orientation behavior. Value should be one of: "perpendicular", "same", "horizontal", or "vertical".

Synopsis
rift-cli execute config set-stack-default-orientation <VALUE>

Arguments

<VALUE>

Set the outer gap on each screen edge.

Synopsis
rift-cli execute config set-outer-gaps <TOP> <LEFT> <BOTTOM> <RIGHT>

Arguments

<TOP>
<LEFT>
<BOTTOM>
<RIGHT>

Set the horizontal and vertical gaps between windows.

Synopsis
rift-cli execute config set-inner-gaps <HORIZONTAL> <VERTICAL>

Arguments

<HORIZONTAL>
<VERTICAL>

Update workspace settings.

Synopsis
rift-cli execute config set-workspace-names [NAMES]...

Arguments

[NAMES]...

Generic set: set an arbitrary config key (dot-separated path) to a JSON value.

Synopsis
rift-cli execute config set <KEY> <VALUE>

Arguments

<KEY>
Dot-separated key path (e.g. settings.animate or settings.layout.gaps.outer.top).
<VALUE>
Value should be valid JSON (true, 1, "string", {"a":1}), but if it's not valid JSON it will be treated as a string.

Get current config.

Synopsis
rift-cli execute config get

Save current config to file.

Synopsis
rift-cli execute config save

Reload config from file.

Synopsis
rift-cli execute config reload