Select which fields to include in query output

[koekeishiya]

New syntax. The only change is the addition of the optional [<PROPERTIES>] value.

Query

General Syntax

yabai -m query <COMMAND> [<PROPERTIES>] [<ARGUMENT>]

COMMAND

--displays
Retrieve information about displays.

--spaces
Retrieve information about spaces.

--windows
Retrieve information about windows.

ARGUMENT

--display [<DISPLAY_SEL>]
Constrain matches to the selected display.

--space [<SPACE_SEL>]
Constrain matches to the selected space.

--window [<WINDOW_SEL>]
Constrain matches to the selected window.

PROPERTIES

A comma-separated string containing the name of fields to include in the output.
The name of the provided fields must be present in the dataformat of the corresponding entity.

DATAFORMAT

DISPLAY
{
    "id": number,
    "uuid": string,
    "index": number,
    "label": string,
    "frame": object {
        "x": number,
        "y": number,
        "w": number,
        "h": number
    },
    "spaces": array of number,
    "has-focus": bool
}

SPACE
{
    "id": number,
    "uuid": string,
    "index": number,
    "label": string,
    "type": string,
    "display": number,
    "windows": array of number,
    "first-window": number,
    "last-window": number,
    "has-focus": bool,
    "is-visible": bool,
    "is-native-fullscreen": bool
}

WINDOW
{
    "id": number,
    "pid": number,
    "app": string,
    "title": string,
    "frame": object {
        "x": number,
        "y": number,
        "w": number,
        "h": number,
    },
    "role": string,
    "subrole": string,
    "root-window": bool,
    "display": number,
    "space": number,
    "level": number,
    "sub-level": number,
    "layer": string,
    "sub-layer": string,
    "opacity": number,
    "split-type": string,
    "split-child": string,
    "stack-index": number,
    "can-move": bool,
    "can-resize": bool,
    "has-focus": bool,
    "has-shadow": bool,
    "has-parent-zoom": bool,
    "has-fullscreen-zoom": bool,
    "has-ax-reference": bool,
    "is-native-fullscreen": bool,
    "is-visible": bool,
    "is-minimized": bool,
    "is-hidden": bool,
    "is-floating": bool,
    "is-sticky": bool,
    "is-grabbed": bool
}

The output will still be a json object or list of json objects, but only the selected properties will be included.

Sample command: yabai -m query --windows id,title --space
Sample response:

[{
    "id":12345,
    "title":"tester"
},
{
    "id":61341,
    "title":"deadbeef"
}]

[Pe8er]

This is amazing, thank you so much. Things feel much more snappy now!

[Bellavene]

Thank you. It works a lot faster in sketchybar