Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/dyoburon/jarvis/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

Jarvis WebViews can send messages to Rust via the IPC bridge. Messages are sent using window.jarvis.ipc.send() in JavaScript and handled by Rust event handlers.

​
Sending Messages

​
JavaScript API

// Send a simple message
window.jarvis.ipc.send('message_type', { key: 'value' });

// Request-response pattern (async)
const result = await window.jarvis.ipc.request('message_type', { key: 'value' });

​
Message Format

All IPC messages have this structure: 
{
  "kind": "message_type",
  "payload": { /* arbitrary JSON */ }
}

​
Built-in Message Types

​
Panel Management

​
panel_focus

Notify Rust that this pane should be focused.
​
kind
string
default:"panel_focus"
Message type.
​
payload
{}
Empty object.
JavaScript: 
window.jarvis.ipc.send('panel_focus', {});
Use case: Automatically sent when the WebView is clicked.

​
Keyboard Input

​
keybind

Forward a keyboard shortcut to Rust for handling.
​
kind
string
default:"keybind"
Message type.
​
payload
object
Keyboard event details.
JavaScript: 
window.jarvis.ipc.send('keybind', {
    key: 'T',
    ctrl: false,
    alt: false,
    shift: false,
    meta: true  // Cmd+T
});
Use case: Forward Cmd+T, Cmd+G, Escape, etc. to Rust so global keybinds work in WebViews.

​
Clipboard

​
clipboard_copy

Copy text to the system clipboard.
​
kind
string
default:"clipboard_copy"
Message type.
​
payload
object
​
text
string
required
Text to copy.
JavaScript: 
window.jarvis.ipc.send('clipboard_copy', {
    text: 'Hello, World!'
});
Use case: WebView clipboard access is restricted on macOS/iOS, so we proxy through Rust.

​
clipboard_paste

Request clipboard content from Rust.
​
kind
string
default:"clipboard_paste"
Message type.
​
payload
{}
Empty object (or include _reqId for request-response).
JavaScript: 
const result = await window.jarvis.ipc.request('clipboard_paste', {});

if (result.kind === 'text') {
    console.log('Clipboard text:', result.text);
} else if (result.kind === 'image') {
    console.log('Clipboard image:', result.data_url);
}
Response: 
{
  "kind": "text",
  "text": "clipboard content"
}
or 
{
  "kind": "image",
  "data_url": "data:image/png;base64,..."
}

​
Terminal Input

​
pty_input

Send input to the PTY (for terminal emulator panes).
​
kind
string
default:"pty_input"
Message type.
​
payload
object
​
data
string
required
Input data to send to the PTY.
JavaScript: 
window.jarvis.ipc.send('pty_input', {
    data: 'ls -la\n'
});
Use case: Used by xterm.js to send keyboard input to the shell.

​
Command Palette

​
palette_click

User clicked an item in the command palette.
​
kind
string
default:"palette_click"
Message type.
​
payload
object
​
index
number
required
Index of the clicked item.
JavaScript: 
window.jarvis.ipc.send('palette_click', { index: 2 });

​
palette_hover

User hovered over an item in the command palette.
​
kind
string
default:"palette_hover"
Message type.
​
payload
object
​
index
number
required
Index of the hovered item.
JavaScript: 
window.jarvis.ipc.send('palette_hover', { index: 1 });

​
palette_dismiss

User dismissed the command palette (clicked outside or pressed Escape).
​
kind
string
default:"palette_dismiss"
Message type.
​
payload
{}
Empty object.
JavaScript: 
window.jarvis.ipc.send('palette_dismiss', {});

​
Debug Events

​
debug_event

Send a debug event to Rust for logging.
​
kind
string
default:"debug_event"
Message type.
​
payload
object
Event details (arbitrary JSON).
JavaScript: 
window.jarvis.ipc.send('debug_event', {
    type: 'mousedown',
    x: 100,
    y: 200,
    target: 'BUTTON#submit'
});
Use case: Temporary diagnostic logging.

​
Custom Messages

You can send custom messages from your WebView content: JavaScript: 
// Send a custom message
window.jarvis.ipc.send('my_custom_event', {
    action: 'do_something',
    data: { foo: 'bar' }
});
Rust: 
use jarvis_webview::{WebViewEvent, IpcMessage};

match event {
    WebViewEvent::IpcMessage { pane_id, body } => {
        if let Some(msg) = IpcMessage::from_json(&body) {
            match msg.kind.as_str() {
                "my_custom_event" => {
                    // Handle custom message
                    println!("Custom event: {:?}", msg.payload);
                }
                _ => {}
            }
        }
    }
    _ => {}
}

​
Request-Response Pattern

For messages that need a response, use request() instead of send(): JavaScript: 
try {
    const result = await window.jarvis.ipc.request('get_config', {});
    console.log('Config:', result);
} catch (error) {
    console.error('Request failed:', error);
}
Rust: 
// Parse request ID from payload
let req_id = payload["_reqId"].as_u64();

// ... handle request ...

// Send response back to JavaScript
let response = json!({
    "_reqId": req_id,
    "result": { /* response data */ }
});

let js = js_dispatch_message("response", &response);
handle.eval(&js);
The request will automatically resolve/reject the JavaScript promise.

​
See Also

Build docs developers (and LLMs) love

Get started for freeTalk to us