Rofi-proxy is a plugin that allows you to manage rofi state with an external application.

To run rofi with plugin:

rofi -modi proxy -show proxy -proxy-cmd "path_to_app"

There is also full support for combi mode:

rofi -modi combi -show combi -combi-modi "proxy,drun" -proxy-cmd "path_to_app"

The "-proxy-log" option causes the rofi-proxy to log to $XDG_DATA_HOME/rofi/proxy.log (or to $HOME/.local/share/rofi/proxy.log if the environment variable XDG_DATA_HOME not set):

rofi -modi proxy -show proxy -proxy-log -proxy-cmd "path_to_app"

Usage examples.

After start it launches the application specified in "-proxy-cmd". The application can send to stdout messages which describes desired state of rofi in json format at any time. All messages must be in single-line json format and end with new line symbol.

• Plugin sends an "input" message each time input line changes. For example:

{
    "name": "input",
    "value": "full_input_string"
}

• When custom (non-matched) input was entered, the plugin sends a message named "select_custom_input". For example:

{
    "name": "select_custom_input",
    "value": "input_string"
}

• When you select a line (press Enter), the plugin will send a "select_line" message with the data for this line. For example:

{
    "name": "select_line",
    "value": {
        "id": "id_string",
        "text": "line_text",
        "group": "group_string"
    }
}

• When you delete a line (press Shift+Delete by default), the plugin will send a "delete_line" message with the data for this line. For example:

{
    "name": "delete_line",
    "value": {
        "id": "id_string",
        "text": "line_text",
        "group": "group_string"
    }
}

• When the hotkey is pressed (see the rofi documentation for options "-kb-custom-1" ... "-kb-custom-19"), the plugin sends a "key_press" message with the code "custom_1" .. "custom_19" (if interception for pressing Escape is allowed then rofi will not close, but will send a message about the pressed key with the code "cancel"). Currently displayed line will be sent in the value of the "line" field. For example:

{
    "name": "key_press",
    "value": {
        "key": "custom_1",
        "line": {
            "id": "id_string",
            "text": "line_text",
            "group": "group_string"
        }
    }
}

At any time, application can send a single line json to the plugin describing the state of the rofi. Here's an example json with a full set of fields:

{
    "prompt": "prompt_text",
    "input": "user_input_text",
    "overlay": "overlay_text",
    "help": "help_text",
    "hide_combi_lines": false,
    "exit_by_cancel": true,
    "lines": [
        {
            "id": "id_text",
            "text": "display_text",
            "group": "group_text",
            "icon": "applications-internet",
            "filtering": true,
            "urgent": false,
            "active": false,
            "markup": false
        },
        ...
    ],
}

All fields in the root json are optional. Here is a description of the fields in the root json:

Description of fields in array lines:

You can install the package rofi-proxy from AUR:

yay -S rofi-proxy

Next buildtime dependencies must be installed:

• git
• cmake
• gcc/clang - compiler with c++17 support
• rofi - required headers only, configuration searched with pkgconfig

git clone https://github.com/ReanGD/rofi-proxy.git
cd rofi-proxy
cmake -B build
sudo cmake --build build --config Release --target install