Skip to content

Configuration commands

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.

Generated from rift-cli at v0.7.0.

Update animation settings.

rift-cli execute config set-animate <VALUE>

Arguments

<VALUE>

Set the animation duration in seconds.

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

Arguments

<VALUE>

Set the animation frame rate.

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

Arguments

<VALUE>

Set the animation easing curve.

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

Arguments

<VALUE>

Update mouse settings.

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

Arguments

<VALUE>
Values
true, false

Show or hide the pointer after focus changes.

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

Arguments

<VALUE>
Values
true, false

Enable or disable focusing windows under the pointer.

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

Arguments

<VALUE>
Values
true, false

Update layout settings.

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".

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

Arguments

<VALUE>

Set the outer gap on each screen edge.

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

Arguments

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

Set the horizontal and vertical gaps between windows.

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

Arguments

<HORIZONTAL>
<VERTICAL>

Update workspace settings.

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

Arguments

[NAMES]...

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

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.

rift-cli execute config get

Save current config to file.

rift-cli execute config save

Reload config from file.

rift-cli execute config reload