windows-use


Namewindows-use JSON
Version 0.6.1 PyPI version JSON
download
home_pageNone
SummaryAn AI Agent that interacts with Windows OS at GUI level.
upload_time2025-09-13 06:22:59
maintainerNone
docs_urlNone
authorNone
requires_python>=3.13
licenseNone
keywords agent ai ai agent automation desktop windows
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <div align="center">

  <h1>🪟 Windows-Use</h1>
  <a href="https://pepy.tech/project/windows-use">
    <img src="https://static.pepy.tech/badge/windows-use" alt="PyPI Downloads">
  </a>
  <a href="https://github.com/CursorTouch/windows-use/blob/main/LICENSE">
    <img src="https://img.shields.io/badge/license-MIT-green" alt="License">
  </a>
  <img src="https://img.shields.io/badge/python-3.12%2B-blue" alt="Python">
  <img src="https://img.shields.io/badge/platform-Windows%207–11-blue" alt="Platform: Windows 7 to 11">
  <br>

  <a href="https://x.com/CursorTouch">
    <img src="https://img.shields.io/badge/follow-%40CursorTouch-1DA1F2?logo=twitter&style=flat" alt="Follow on Twitter">
  </a>
  <a href="https://discord.com/invite/Aue9Yj2VzS">
    <img src="https://img.shields.io/badge/Join%20on-Discord-5865F2?logo=discord&logoColor=white&style=flat" alt="Join us on Discord">
  </a>

</div>

<br>

**Windows-Use** is a powerful automation agent that interact directly with the Windows at GUI layer. It bridges the gap between AI Agents and the Windows OS to perform tasks such as opening apps, clicking buttons, typing, executing shell commands, and capturing UI state all without relying on traditional computer vision models. Enabling any LLM to perform computer automation instead of relying on specific models for it.

## 🛠️Installation Guide

### **Prerequisites**

- Python 3.12 or higher
- [UV](https://github.com/astral-sh/uv) (or `pip`)
- Windows 7 or 8 or 10 or 11

### **Installation Steps**

**Install using `uv`:**

```bash
uv pip install windows-use
````

Or with pip:

```bash
pip install windows-use
```

## ⚙️Basic Usage

```python
# main.py
from langchain_google_genai import ChatGoogleGenerativeAI
from windows_use.agent import Agent
from dotenv import load_dotenv

load_dotenv()

llm=ChatGoogleGenerativeAI(model='gemini-2.0-flash')
agent = Agent(llm=llm,browser='chrome',use_vision=True)
query=input("Enter your query: ")
agent_result=agent.invoke(query=query)
print(agent_result.content)
```

## 🤖 Run Agent

You can use the following to run from a script:

```bash
python main.py
Enter your query: <YOUR TASK>
```

---

## 🎥 Demos

**PROMPT:** Write a short note about LLMs and save to the desktop

<https://github.com/user-attachments/assets/0faa5179-73c1-4547-b9e6-2875496b12a0>

**PROMPT:** Change from Dark mode to Light mode

<https://github.com/user-attachments/assets/47bdd166-1261-4155-8890-1b2189c0a3fd>

## 📈 Grounding

![Image](https://github.com/user-attachments/assets/e1d32725-e28a-4821-9c89-24b5ba2e583f)
![Image](https://github.com/user-attachments/assets/be72ad43-c320-4831-95cf-6f1f30df18de)
![Image](https://github.com/user-attachments/assets/d91b513e-13a0-4451-a6e9-f1e16def36e3)
![Image](https://github.com/user-attachments/assets/b5ef5bcf-0e15-4c87-93fe-0f9a983536e5)
![Image](https://github.com/user-attachments/assets/2b5cada6-4ca1-4e0c-8a10-2df29911b1cb)

## Vision

Talk to your computer. Watch it get things done.

## Star History

[![Star History Chart](https://api.star-history.com/svg?repos=CursorTouch/Windows-Use&type=Date)](https://www.star-history.com/#CursorTouch/Windows-Use&Date)

## ⚠️ Caution

Agent interacts directly with your Windows OS at GUI layer to perform actions. While the agent is designed to act intelligently and safely, it can make mistakes that might bring undesired system behaviour or cause unintended changes. Try to run the agent in a sandbox envirnoment.

## 🪪 License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## 🤝 Contributing

Contributions are welcome! Please check the [CONTRIBUTING](CONTRIBUTING) file for setup and development workflow.

Made with ❤️ by [Jeomon George](https://github.com/Jeomon)

---

## Citation

```bibtex
@software{
  author       = {George, Jeomon},
  title        = {Windows-Use: Enable AI to control Windows OS},
  year         = {2025},
  publisher    = {GitHub},
  url={https://github.com/CursorTouch/Windows-Use}
}
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "windows-use",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.13",
    "maintainer_email": null,
    "keywords": "agent, ai, ai agent, automation, desktop, windows",
    "author": null,
    "author_email": "Jeomon George <jeogeoalukka@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/00/3c/a06535be15f520187a3e5f5104185986bf2524eaabdde0deee5ec4c6ee99/windows_use-0.6.1.tar.gz",
    "platform": null,
    "description": "<div align=\"center\">\n\n  <h1>\ud83e\ude9f Windows-Use</h1>\n  <a href=\"https://pepy.tech/project/windows-use\">\n    <img src=\"https://static.pepy.tech/badge/windows-use\" alt=\"PyPI Downloads\">\n  </a>\n  <a href=\"https://github.com/CursorTouch/windows-use/blob/main/LICENSE\">\n    <img src=\"https://img.shields.io/badge/license-MIT-green\" alt=\"License\">\n  </a>\n  <img src=\"https://img.shields.io/badge/python-3.12%2B-blue\" alt=\"Python\">\n  <img src=\"https://img.shields.io/badge/platform-Windows%207\u201311-blue\" alt=\"Platform: Windows 7 to 11\">\n  <br>\n\n  <a href=\"https://x.com/CursorTouch\">\n    <img src=\"https://img.shields.io/badge/follow-%40CursorTouch-1DA1F2?logo=twitter&style=flat\" alt=\"Follow on Twitter\">\n  </a>\n  <a href=\"https://discord.com/invite/Aue9Yj2VzS\">\n    <img src=\"https://img.shields.io/badge/Join%20on-Discord-5865F2?logo=discord&logoColor=white&style=flat\" alt=\"Join us on Discord\">\n  </a>\n\n</div>\n\n<br>\n\n**Windows-Use** is a powerful automation agent that interact directly with the Windows at GUI layer. It bridges the gap between AI Agents and the Windows OS to perform tasks such as opening apps, clicking buttons, typing, executing shell commands, and capturing UI state all without relying on traditional computer vision models. Enabling any LLM to perform computer automation instead of relying on specific models for it.\n\n## \ud83d\udee0\ufe0fInstallation Guide\n\n### **Prerequisites**\n\n- Python 3.12 or higher\n- [UV](https://github.com/astral-sh/uv) (or `pip`)\n- Windows 7 or 8 or 10 or 11\n\n### **Installation Steps**\n\n**Install using `uv`:**\n\n```bash\nuv pip install windows-use\n````\n\nOr with pip:\n\n```bash\npip install windows-use\n```\n\n## \u2699\ufe0fBasic Usage\n\n```python\n# main.py\nfrom langchain_google_genai import ChatGoogleGenerativeAI\nfrom windows_use.agent import Agent\nfrom dotenv import load_dotenv\n\nload_dotenv()\n\nllm=ChatGoogleGenerativeAI(model='gemini-2.0-flash')\nagent = Agent(llm=llm,browser='chrome',use_vision=True)\nquery=input(\"Enter your query: \")\nagent_result=agent.invoke(query=query)\nprint(agent_result.content)\n```\n\n## \ud83e\udd16 Run Agent\n\nYou can use the following to run from a script:\n\n```bash\npython main.py\nEnter your query: <YOUR TASK>\n```\n\n---\n\n## \ud83c\udfa5 Demos\n\n**PROMPT:** Write a short note about LLMs and save to the desktop\n\n<https://github.com/user-attachments/assets/0faa5179-73c1-4547-b9e6-2875496b12a0>\n\n**PROMPT:** Change from Dark mode to Light mode\n\n<https://github.com/user-attachments/assets/47bdd166-1261-4155-8890-1b2189c0a3fd>\n\n## \ud83d\udcc8 Grounding\n\n![Image](https://github.com/user-attachments/assets/e1d32725-e28a-4821-9c89-24b5ba2e583f)\n![Image](https://github.com/user-attachments/assets/be72ad43-c320-4831-95cf-6f1f30df18de)\n![Image](https://github.com/user-attachments/assets/d91b513e-13a0-4451-a6e9-f1e16def36e3)\n![Image](https://github.com/user-attachments/assets/b5ef5bcf-0e15-4c87-93fe-0f9a983536e5)\n![Image](https://github.com/user-attachments/assets/2b5cada6-4ca1-4e0c-8a10-2df29911b1cb)\n\n## Vision\n\nTalk to your computer. Watch it get things done.\n\n## Star History\n\n[![Star History Chart](https://api.star-history.com/svg?repos=CursorTouch/Windows-Use&type=Date)](https://www.star-history.com/#CursorTouch/Windows-Use&Date)\n\n## \u26a0\ufe0f Caution\n\nAgent interacts directly with your Windows OS at GUI layer to perform actions. While the agent is designed to act intelligently and safely, it can make mistakes that might bring undesired system behaviour or cause unintended changes. Try to run the agent in a sandbox envirnoment.\n\n## \ud83e\udeaa License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## \ud83e\udd1d Contributing\n\nContributions are welcome! Please check the [CONTRIBUTING](CONTRIBUTING) file for setup and development workflow.\n\nMade with \u2764\ufe0f by [Jeomon George](https://github.com/Jeomon)\n\n---\n\n## Citation\n\n```bibtex\n@software{\n  author       = {George, Jeomon},\n  title        = {Windows-Use: Enable AI to control Windows OS},\n  year         = {2025},\n  publisher    = {GitHub},\n  url={https://github.com/CursorTouch/Windows-Use}\n}\n```\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "An AI Agent that interacts with Windows OS at GUI level.",
    "version": "0.6.1",
    "project_urls": {
        "homepage": "https://github.com/CursorTouch"
    },
    "split_keywords": [
        "agent",
        " ai",
        " ai agent",
        " automation",
        " desktop",
        " windows"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "6d44acaf46ccfcb4f3cd27569f1ce91bbc45c3a1b7f983b1cada88d948800d64",
                "md5": "9d936d8163b082160d6f47a9d308a0a3",
                "sha256": "248432e1b9f7f906ff055dc6d3b3d7ef0360b089c18f20614e747109caf242d0"
            },
            "downloads": -1,
            "filename": "windows_use-0.6.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "9d936d8163b082160d6f47a9d308a0a3",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.13",
            "size": 30289,
            "upload_time": "2025-09-13T06:22:58",
            "upload_time_iso_8601": "2025-09-13T06:22:58.724228Z",
            "url": "https://files.pythonhosted.org/packages/6d/44/acaf46ccfcb4f3cd27569f1ce91bbc45c3a1b7f983b1cada88d948800d64/windows_use-0.6.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "003ca06535be15f520187a3e5f5104185986bf2524eaabdde0deee5ec4c6ee99",
                "md5": "e8c94c663e516fe9de9b2d50e94b5d55",
                "sha256": "150abec94dfd064b69ea1752c7120da5a66eef91b7e1d953be2a266d104fce70"
            },
            "downloads": -1,
            "filename": "windows_use-0.6.1.tar.gz",
            "has_sig": false,
            "md5_digest": "e8c94c663e516fe9de9b2d50e94b5d55",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.13",
            "size": 23313,
            "upload_time": "2025-09-13T06:22:59",
            "upload_time_iso_8601": "2025-09-13T06:22:59.790175Z",
            "url": "https://files.pythonhosted.org/packages/00/3c/a06535be15f520187a3e5f5104185986bf2524eaabdde0deee5ec4c6ee99/windows_use-0.6.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-09-13 06:22:59",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "windows-use"
}
        
Elapsed time: 1.36977s