{"id":13624117,"url":"https://github.com/OS-Copilot/OS-Copilot","last_synced_at":"2025-04-15T20:33:18.477Z","repository":{"id":222233516,"uuid":"751635025","full_name":"OS-Copilot/OS-Copilot","owner":"OS-Copilot","description":"An self-improving embodied conversational agent seamlessly integrated into the operating system to automate our daily tasks. ","archived":false,"fork":false,"pushed_at":"2024-09-09T02:11:13.000Z","size":34692,"stargazers_count":1640,"open_issues_count":16,"forks_count":181,"subscribers_count":23,"default_branch":"main","last_synced_at":"2025-04-11T14:17:04.003Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/OS-Copilot.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":"docs/roadmap.md","authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-02-02T01:55:49.000Z","updated_at":"2025-04-11T02:29:23.000Z","dependencies_parsed_at":"2024-02-19T10:00:39.871Z","dependency_job_id":"ef60b359-c4a8-4d44-b62b-13625717054f","html_url":"https://github.com/OS-Copilot/OS-Copilot","commit_stats":null,"previous_names":["os-copilot/friday","os-copilot/os-copilot"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OS-Copilot%2FOS-Copilot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OS-Copilot%2FOS-Copilot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OS-Copilot%2FOS-Copilot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OS-Copilot%2FOS-Copilot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OS-Copilot","download_url":"https://codeload.github.com/OS-Copilot/OS-Copilot/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248609119,"owners_count":21132850,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T21:01:38.974Z","updated_at":"2025-04-15T20:33:18.443Z","avatar_url":"https://github.com/OS-Copilot.png","language":"Python","readme":"# OS-Copilot: Towards Generalist Computer Agents with Self-Improvement\n\n\u003cdiv align=\"center\"\u003e\n\n\u003c!-- [[PDF]](https://arxiv.org/pdf/2402.07456.pdf)\n[[Documentation]](https://os-copilot.readthedocs.io/en/latest/) --\u003e\n\n[![Website](https://img.shields.io/website?url=https://os-copilot.github.io/)](https://os-copilot.github.io/)\n[![Paper](https://img.shields.io/badge/paper--blue)](https://arxiv.org/pdf/2402.07456.pdf)\n[![Documentation](https://img.shields.io/badge/documentation--blue)](https://os-copilot.readthedocs.io/en/latest/)\n![Python](https://img.shields.io/badge/python-3.10-blue)\n[![Discord](https://img.shields.io/discord/1222168244673314847?logo=discord\u0026style=flat)](https://discord.com/invite/rXS2XbgfaD)\n[![Twitter](https://img.shields.io/twitter/url/https/twitter.com/cloudposse.svg?style=social\u0026label=Follow%20%40oscopilot)](https://twitter.com/oscopilot)\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src='pic/demo.png' width=\"100%\"\u003e\n\u003c/p\u003e\n\n\u003c/div\u003e\n\n\u003c!-- ## 📖 Overview\n\n- **OS-Copilot** is a pioneering conceptual framework for building generalist computer agents on Linux and MacOS, which provides a unified interface for app interactions in the heterogeneous OS ecosystem.\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src='pic/framework.png' width=\"75%\"\u003e\n\u003c/p\u003e\n- Leveraging OS-Copilot, we built **FRIDAY**, a self-improving AI assistant capable of solving general computer tasks.\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src='pic/FRIDAY.png' width=\"75%\"\u003e\n\u003c/p\u003e --\u003e\n\n## 🔥 News\n\n- _2024.9_: 🎉 Now Friday is equipped with vision! Try out the new [friday_vision](https://github.com/OS-Copilot/OS-Copilot/tree/main/examples/friday_vision)! Currently still under development but more stable versions are expected soon.\n- _2024.6_: 🎉 The front-end interface of OS-Copilot is now available. Go check it out in the [frontend](https://github.com/OS-Copilot/OS-Copilot/tree/main/fronted) directory!\n- _2024.3_: 🎉 OS-Copilot is accepted at the [LLM Agents Workshop](https://llmagents.github.io/)@ICLR 2024!\n\n## What is OS-Copilot\n\nOS-Copilot is an open-source library to build generalist agents capable of automatically interfacing with comprehensive elements in an operating system (OS), including the web, code terminals, files, multimedia, and various third-party applications.\n\n## ⚡️ Quickstart\n\n1. **Clone the GitHub Repository:**\n\n   ```\n   git clone https://github.com/OS-Copilot/OS-Copilot.git\n   ```\n\n2. **Set Up Python Environment and Install Dependencies:**\n\n   ```\n   conda create -n oscopilot_env python=3.10 -y\n   conda activate oscopilot_env\n\n   cd OS-Copilot\n   pip install -e .\n   ```\n\n3. **Set OpenAI API Key:** Configure your OpenAI API key in [.env](.env).\n\n   ```\n   cp .env_template .env\n   ```\n\n4. **Now you are ready to have fun:**\n   ```\n   python quick_start.py\n   ```\n\n\\* **FRIDAY currently only supports single-round conversation**.\n\n## 🛠️ Tutorial\n\n| **Level**        | **Tutorial**                                                                                                                              | **Description**                                                                |\n| ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ |\n| **Beginner**     | [Installation](https://os-copilot.readthedocs.io/en/latest/installation.html)                                                             | Explore three methods to install FRIDAY.                                       |\n| **Beginner**     | [Getting Started](https://os-copilot.readthedocs.io/en/latest/quick_start.html)                                                           | The simplest demonstration of FRIDAY with a quick_start.py script.             |\n| **Intermediate** | [Adding Your Tools](https://os-copilot.readthedocs.io/en/latest/tutorials/add_tool.html)                                                  | Adding and removing tools to the FRIDAY.                                       |\n| **Intermediate** | [Deploying API Services](https://os-copilot.readthedocs.io/en/latest/tutorials/deploy_api_service.html)                                   | Demonstrate the deployment of API services for FRIDAY.                         |\n| **Intermediate** | [Example: Automating Excel Tasks](https://os-copilot.readthedocs.io/en/latest/tutorials/example_excel.html)                               | Automating Excel control using FRIDAY.                                         |\n| **Intermediate** | [Enhancing FRIDAY with Self-Learning for Excel Task Automation](https://os-copilot.readthedocs.io/en/latest/tutorials/self_learning.html) | Improved Excel control with self-directed learning.                            |\n| **Advanced**     | [Designing New API Tools](https://os-copilot.readthedocs.io/en/latest/tutorials/design_new_api_tool.html)                                 | Guides on deploying custom API tools for FRIDAY to extend its functionalities. |\n\n\u003c!-- ## 🛠️ FRIDAY-Gizmos\nWe maintain an open-source library of toolkits for FRIDAY, which includes tools that can be directly utilized within FRIDAY.\nFor a detailed list of tools, please see [FRIDAY-Gizmos](https://github.com/OS-Copilot/FRIDAY-Gizmos). The usage methods are as follows:\n\n1. Find the tool you want to use in [FRIDAY-Gizmos](https://github.com/OS-Copilot/FRIDAY-Gizmos) and download its tool code.\n2. Add the tool to FRIDAY's toolkit:\n```shell\npython friday/tool_repository/manager/tool_manager.py --add --tool_name [tool_name] --tool_path [tool_path]\n```\n3. If you wish to remove a tool, you can run:\n```shell\npython friday/tool_repository/manager/tool_manager.py --delete --tool_name [tool_name]\n```\n\n## 💻 User Interface (UI)\n\n**Enhance Your Experience with Our Intuitive Frontend!** This interface is crafted for effortless control of your agents. For more details, visit [FRIDAY Frontend](https://github.com/OS-Copilot/FRIDAY-front).\n\n## ✨ Deploy API Services\n\nFor comprehensive guidelines on deploying API services, please refer to the [OS-Copilot documentation](https://os-copilot.readthedocs.io/en/latest/).  --\u003e\n\n## 💻 User Interface (UI)\n\n**Enhance Your Experience with Our Intuitive Frontend!** This interface is crafted for effortless control of your agents. For more details, visit [OS-Copilot Frontend](https://github.com/OS-Copilot/OS-Copilot/tree/main/fronted).\n\n## 🏫 Community\n\nJoin our community to connect with other enthusiasts, researchers and developers:\n\n- **[Discord](https://discord.com/invite/rXS2XbgfaD)**: Join our Discord server for real-time discussions and support.\n- **[Twitter](https://twitter.com/oscopilot)**: Follow our Twitter to get latest new or tag us to share your demos!\n\n## 👨‍💻‍ Contributing\n\n**Visit [the roadmap](./docs/roadmap.md) to preview what the community is working on and become a contributor!**\n\n\u003ca href=\"https://github.com/OS-Copilot/OS-Copilot/graphs/contributors\"\u003e\n  \u003cimg src=\"https://contrib.rocks/image?repo=OS-Copilot/OS-Copilot\" /\u003e\n\u003c/a\u003e\n\n\u003c!-- Made with [contrib.rocks](https://contrib.rocks). --\u003e\n\n## 🛡 Disclaimer\n\nOS-Copilot is provided \"as is\" without warranty of any kind. Users assume full responsibility for any risks associated with its use, including **potential data loss** or **changes to system settings**. The developers of OS-Copilot are not liable for any damages or losses resulting from its use. Users must ensure their actions comply with applicable laws and regulations.\n\n## 🔎 Citation\n\n```\n@article{wu2024copilot,\n  title={Os-copilot: Towards generalist computer agents with self-improvement},\n  author={Wu, Zhiyong and Han, Chengcheng and Ding, Zichen and Weng, Zhenmin and Liu, Zhoumianze and Yao, Shunyu and Yu, Tao and Kong, Lingpeng},\n  journal={arXiv preprint arXiv:2402.07456},\n  year={2024}\n}\n```\n\n## 📬 Contact\n\nIf you have any inquiries, suggestions, or wish to contact us for any reason, we warmly invite you to email us at wuzhiyong@pjlab.org.cn.\n\n## Star History\n\n![Star History Chart](https://api.star-history.com/svg?repos=OS-Copilot/OS-Copilot\u0026type=Date)\n","funding_links":[],"categories":["Python","Papers","Personal Assistants \u0026 Conversational Agents","AI开源项目"],"sub_categories":["Models","Frameworks \u0026 Models","Virtual Assistants","AI Agent"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FOS-Copilot%2FOS-Copilot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FOS-Copilot%2FOS-Copilot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FOS-Copilot%2FOS-Copilot/lists"}