Skip to content
View uindow's full-sized avatar

Block or report uindow

Block user

Prevent this user from interacting with your repositories and sending you notifications. Learn more about blocking users.

You must be logged in to block users.

Maximum 250 characters. Please don’t include any personal information such as legal names or email addresses. Markdown is supported. This note will only be visible to you.
Report abuse

Contact GitHub support about this user’s behavior. Learn more about reporting abuse.

Report abuse
uindow/README.md

Uindow - UI testing and web automation with trusted interactions

Installation

Command-line interface

You can run Uindow from any CI/CD pipeline or command-line interface.

npx -y @uindow/cli --help

Alternatively, you can use node ./node_modules/uindow/dist/bin.js --help instead of npx @uindow/cli --help for a faster response.

  USAGE
    $ npx @uindow/cli <command> [options]

  AVAILABLE COMMANDS
    $ npx @uindow/cli mcp          Run MCP server
    $ npx @uindow/cli app:docs     Fetch SDK documentation
    $ npx @uindow/cli app:start    Start application
    $ npx @uindow/cli app:stop     Stop application
    $ npx @uindow/cli app:status   Check application status
    $ npx @uindow/cli list         List agents
    $ npx @uindow/cli create       Create agent
    $ npx @uindow/cli update       Update agent
    $ npx @uindow/cli delete       Delete agent
    $ npx @uindow/cli start        Start agent
    $ npx @uindow/cli stop         Stop agent
    $ npx @uindow/cli status       Check agent status
    $ npx @uindow/cli execute      Execute code in agent
    $ npx @uindow/cli logs         Fetch agent logs

  OPTIONS
    --help      Help menu for a specific command
    --version   Package version

All commands that specify the @return tag in their description return valid JSON-formatted values.

Model Context Protocol server

Control Uindow web-automation agents from any MCP-compatible assistant. The server runs locally over stdio and is launched on demand with npx.

Tools exposed: app_docs, app_start, app_stop, app_status, list, create, update, delete, start, stop, status, execute, logs.

Call list first to discover agent indexes.

Install

All clients use the same launch command — npx -y @uindow/cli mcp — only the file location and the wrapping key differ.

Claude Desktop

Edit claude_desktop_config.json (Settings → Developer → Edit Config):

{
    "mcpServers": {
        "uindow": {
            "command": "npx",
            "args": ["-y", "@uindow/cli", "mcp"]
        }
    }
}

Restart Claude Desktop. The Uindow tools appear under the tools (🔌) menu.

Claude Code

claude mcp add uindow -- npx -y @uindow/cli mcp

Cursor

Edit ~/.cursor/mcp.json (global) or .cursor/mcp.json (per project) — same shape as Claude Desktop:

{
    "mcpServers": {
        "uindow": {
            "command": "npx",
            "args": ["-y", "@uindow/cli", "mcp"]
        }
    }
}

VS Code

Create .vscode/mcp.json in your workspace (or run MCP: Open User Configuration for a global setup). Note the root key here is servers, not mcpServers:

{
    "servers": {
        "uindow": {
            "command": "npx",
            "args": ["-y", "@uindow/cli", "mcp"]
        }
    }
}

Other clients

Any client that speaks MCP over stdio works. Point it at the command npx with arguments -y @uindow/cli mcp.

✨ Latest release

Create an account at Uindow and follow the on-screen instructions.

📦 Older release

To install an older version, visit the Releases page and download the appropriate installer.

🌙 Nightly build

To run the latest (unreleased) version of Uindow, clone this repository and run the following commands:

git clone https://github.com/uindow/uindow.git uindow
cd uindow
npm install
npm start

Creating modules

Building Uindow modules is easy:

  1. Visit the Uindow SDK Reference
  2. Download the sample module and import it into Uindow
  3. Start experimenting with dollar-sign methods - the integrated editor features auto-complete and code hints

Popular repositories Loading

  1. uindow uindow Public

    The programmable browser for real-world workflows

    JavaScript 6

  2. css css Public

    The smarter CSS selector generator

    TypeScript 4

  3. dos dos Public

    Explain visually

    JavaScript 3

  4. uindow.github.io uindow.github.io Public

    UI testing and web automation with trusted interactions