Skip to main content

WinUse CLI

The WinUse CLI (winuse) is a simple, scriptable wrapper around the WinUse Windows API. It can target a local Windows host or a remote Windows machine over LAN.

Project homepage: github.com/nedos/winuse

Install

pip install winuse-cli

Configure

By default it talks to http://127.0.0.1:8080. Override with:

export WINUSE_HOST="http://192.168.1.100:8080"

Or pass --host per command.

If you are on WSL or behind a proxy, bypass proxies:

export NO_PROXY='*'
export no_proxy='*'

Commands

  • health — check server status
  • windows — list windows
  • active — get active window
  • focus <hwnd>
  • minimize <hwnd>
  • maximize <hwnd>
  • restore <hwnd>
  • screenshot [--hwnd <hwnd>]
  • mouse-move <x> <y> [--duration <seconds>]
  • mouse-click [--x <x>] [--y <y>] [--button left|right|middle] [--clicks N]
  • type <text> [--mode paste|type] [--interval <sec>]
  • paste <text>
  • press <key> [key ...]

Examples

winuse health
winuse windows
winuse active
winuse focus 2293790
winuse screenshot
winuse screenshot --hwnd 2293790
winuse type "Hello from WinUse" --mode paste
winuse paste "Привет, Сам"
winuse press ctrl v
winuse mouse-move 10 10 --duration 0.2
winuse mouse-click --x 10 --y 10 --button left --clicks 1

Integration test helper

From repo root:

scripts/integration_test_cmd_window.sh

That script will:

  • Open Notepad via Win+R
  • Paste a timestamped message
  • Refocus the window
  • Type a suffix character-by-character
  • Capture before/after screenshots

Tips

  • For UTF-8 text, prefer paste or type --mode paste.
  • If a window loses focus, call focus <hwnd> before typing.
  • The CLI prints JSON responses for scripting.

License

MIT. See ../LICENSE.

Metadata

Release files for winuse 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for winuse 0.1.0
File Size Uploaded Provenance Actions
winuse-0.1.0.tar.gz 3.5 kB Without provenance Details for winuse-0.1.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for winuse 0.1.0
File Interpreter ABI Platform Actions
winuse-0.1.0-py3-none-any.whl Python 3 none any Details for winuse-0.1.0-py3-none-any.whl

Total release size: 7.5 kB

Release files / winuse-0.1.0.tar.gz

Download URL winuse-0.1.0.tar.gz
Size 3.5 kB
Tags Source
SHA-256 checksum
How to use checksums
a8a28c034c1e18c15042f9077562082558d30641692afaadf5d1e5cd5ab65eca
BLAKE2b-256 checksum
How to use checksums
d0c0bda33b6b62cd04859384a51ad6252fb1aab3ea6798169209b42e03629df0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.3

Release files / winuse-0.1.0-py3-none-any.whl

Download URL winuse-0.1.0-py3-none-any.whl
Size 4.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3f7ab9f62191fc138d0be603a2b10f1c496a5e600a592c76cf24ab60742da176
BLAKE2b-256 checksum
How to use checksums
64b500fe9298b2d2d33a964ea33cd9e67e7430521278076bc2f4d07cfe7df870
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.3

Security for winuse 0.1.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page