Query commands

Source version: main.

Queries read state without changing it. Set RIFT_CLI_PRETTY=1 to format returned JSON for reading.

workspaces

List virtual workspaces (optionally for a specific macOS space).

Synopsis

$rift-cli query workspaces [OPTIONS]

Options

--space-id <SPACE_ID>

macOS space ID; defaults to the active display space.

--display <UUID>

Display UUID; uses the display's current macOS space.

windows

List windows (optionally filtered by space).

Synopsis

$rift-cli query windows [OPTIONS]

Options

--space-id <SPACE_ID>

macOS space ID; defaults to the active display space.

--display <UUID>

Display UUID; uses the display's current macOS space.

displays

List connected displays.

Synopsis

$rift-cli query displays

window

Get information about a specific window.

Synopsis

$rift-cli query window <WINDOW_ID>

Arguments

<WINDOW_ID>

applications

List running applications.

Synopsis

$rift-cli query applications

layout

Get layout state and normalized container tree for a space.

Synopsis

$rift-cli query layout [OPTIONS]

Options

--space-id <SPACE_ID>

macOS space ID; defaults to the active display space.

--display <UUID>

Display UUID; uses the display's current macOS space.

--workspace-id <WORKSPACE_ID>

Virtual workspace index; defaults to the active workspace.

workspace-layout

Get workspace layout-engine mode(s).

Synopsis

$rift-cli query workspace-layout [OPTIONS]

Options

--space-id <SPACE_ID>

macOS space ID; defaults to the active display space.

--display <UUID>

Display UUID; uses the display's current macOS space.

--workspace-id <WORKSPACE_ID>

binding-mode

Get the active binding mode name.

Synopsis

$rift-cli query binding-mode

metrics

Get performance metrics.

Synopsis

$rift-cli query metrics

See also

• Execute commands
• Subscriptions