docs.rs failed to build tauri-plugin-automation-server-0.1.0
Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.

Visit the last successful build: tauri-plugin-automation-server-0.2.0

tauri-plugin-automation

HTTP automation server for Tauri apps. Enables external control and automated testing.

Why?

Tauri's WebDriver support doesn't work on macOS (WKWebView lacks a driver). This plugin provides a lightweight HTTP API alternative that works everywhere.

Features

HTTP API on port 9876 for external control
DOM commands: click, type, getText, navigate, waitFor, etc.
Screenshots: Capture the current page as PNG
Works on macOS: No WebDriver needed
Scriptable: Perfect for automated testing tools

Installation

Rust

Add to your Cargo.toml:

[dependencies]
tauri-plugin-automation-server = { git = "https://github.com/dcherrera/tauri-plugin-automation" }

Update your main.rs:

fn main() {
    tauri::Builder::default()
        .plugin(tauri_plugin_automation_server::init())
        .invoke_handler(tauri::generate_handler![
            tauri_plugin_automation_server::automation_screenshot_data
        ])
        .run(tauri::generate_context!())
        .expect("error while running tauri application");
}

JavaScript

Copy guest-js/src/ to your project, or install from npm (when published):

npm install tauri-plugin-automation-api

Initialize in your app entry point:

import { initAutomation } from './automation'  // or 'tauri-plugin-automation-api'

// After your app mounts
initAutomation()

API

Health Check

curl http://localhost:9876/automation/health

{"status": "ok", "port": 9876, "version": "1.0.0"}

Execute Command

curl -X POST http://localhost:9876/automation/execute \
  -H "Content-Type: application/json" \
  -d '{"command": "click", "args": {"selector": "#my-button"}}'

Screenshot

curl http://localhost:9876/automation/screenshot --output screenshot.png

Available Commands

Command	Args	Description
`navigate`	`{path}`	Navigate to route
`click`	`{selector}`	Click element
`type`	`{selector, text}`	Type into input
`clear`	`{selector}`	Clear input
`getText`	`{selector}`	Get element text
`getValue`	`{selector}`	Get input value
`getAttribute`	`{selector, attribute}`	Get attribute
`exists`	`{selector}`	Check if element exists
`waitFor`	`{selector, timeout?}`	Wait for element
`select`	`{selector, value}`	Select dropdown option
`check`	`{selector}`	Check checkbox
`uncheck`	`{selector}`	Uncheck checkbox
`getUrl`	-	Get current URL
`getTitle`	-	Get page title
`focus`	`{selector}`	Focus element
`blur`	`{selector}`	Blur element
`pressKey`	`{key, selector?}`	Press keyboard key
`scrollTo`	`{selector}`	Scroll to element
`submit`	`{selector}`	Submit form
`wait`	`{ms}`	Wait milliseconds
`eval`	`{script}`	Execute JavaScript
`getElements`	`{selector}`	Get all matching elements
`getHtml`	`{selector?}`	Get element HTML

Example: Automated Testing

import requests

BASE = "http://localhost:9876/automation"

# Navigate to login
requests.post(f"{BASE}/execute", json={
    "command": "navigate",
    "args": {"path": "/login"}
})

# Fill form
requests.post(f"{BASE}/execute", json={
    "command": "type",
    "args": {"selector": "#email", "text": "test@example.com"}
})

requests.post(f"{BASE}/execute", json={
    "command": "type",
    "args": {"selector": "#password", "text": "password123"}
})

# Submit
requests.post(f"{BASE}/execute", json={
    "command": "click",
    "args": {"selector": "#login-button"}
})

# Take screenshot to verify
response = requests.get(f"{BASE}/screenshot")
with open("result.png", "wb") as f:
    f.write(response.content)

Security

This plugin opens an HTTP server on localhost. For production:

Disable in release builds using Cargo features:

[features]
default = []  # Don't include automation by default
automation = ["tauri-plugin-automation"]

Only enable when needed:

cargo build --features automation

License

MIT Transparency License - see LICENSE

tauri-plugin-automation-server 0.1.0