You can run Uindow from any CI/CD pipeline or command-line interface.
npx -y @uindow/cli --helpAlternatively, 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.
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.
All clients use the same launch command — npx -y @uindow/cli mcp — only the file
location and the wrapping key differ.
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 mcp add uindow -- npx -y @uindow/cli mcpEdit ~/.cursor/mcp.json (global) or .cursor/mcp.json (per project) — same shape
as Claude Desktop:
{
"mcpServers": {
"uindow": {
"command": "npx",
"args": ["-y", "@uindow/cli", "mcp"]
}
}
}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"]
}
}
}Any client that speaks MCP over stdio works. Point it at the command npx with
arguments -y @uindow/cli mcp.
Create an account at Uindow and follow the on-screen instructions.
To install an older version, visit the Releases page and download the appropriate installer.
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 startBuilding Uindow modules is easy:
- Visit the Uindow SDK Reference
- Download the sample module and import it into Uindow
- Start experimenting with dollar-sign methods - the integrated editor features auto-complete and code hints