https://github.com/OS-Copilot/OS-Copilot
An self-improving embodied conversational agent seamlessly integrated into the operating system to automate our daily tasks.
https://github.com/OS-Copilot/OS-Copilot
Last synced: 21 days ago
JSON representation
An self-improving embodied conversational agent seamlessly integrated into the operating system to automate our daily tasks.
- Host: GitHub
- URL: https://github.com/OS-Copilot/OS-Copilot
- Owner: OS-Copilot
- License: mit
- Created: 2024-02-02T01:55:49.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-09T02:11:13.000Z (8 months ago)
- Last Synced: 2025-04-11T14:17:04.003Z (25 days ago)
- Language: Python
- Homepage:
- Size: 33.1 MB
- Stars: 1,640
- Watchers: 23
- Forks: 181
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Roadmap: docs/roadmap.md
Awesome Lists containing this project
- awesome-ui-agents - code
- awesome-ui-agents - code
- acu - Code
README
# OS-Copilot: Towards Generalist Computer Agents with Self-Improvement
[](https://os-copilot.github.io/)
[](https://arxiv.org/pdf/2402.07456.pdf)
[](https://os-copilot.readthedocs.io/en/latest/)
[](https://discord.com/invite/rXS2XbgfaD)
[](https://twitter.com/oscopilot)
## 🔥 News
- _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.
- _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!
- _2024.3_: 🎉 OS-Copilot is accepted at the [LLM Agents Workshop](https://llmagents.github.io/)@ICLR 2024!
## What is OS-Copilot
OS-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.
## ⚡️ Quickstart
1. **Clone the GitHub Repository:**
```
git clone https://github.com/OS-Copilot/OS-Copilot.git
```
2. **Set Up Python Environment and Install Dependencies:**
```
conda create -n oscopilot_env python=3.10 -y
conda activate oscopilot_env
cd OS-Copilot
pip install -e .
```
3. **Set OpenAI API Key:** Configure your OpenAI API key in [.env](.env).
```
cp .env_template .env
```
4. **Now you are ready to have fun:**
```
python quick_start.py
```
\* **FRIDAY currently only supports single-round conversation**.
## 🛠️ Tutorial
| **Level** | **Tutorial** | **Description** |
| ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
| **Beginner** | [Installation](https://os-copilot.readthedocs.io/en/latest/installation.html) | Explore three methods to install FRIDAY. |
| **Beginner** | [Getting Started](https://os-copilot.readthedocs.io/en/latest/quick_start.html) | The simplest demonstration of FRIDAY with a quick_start.py script. |
| **Intermediate** | [Adding Your Tools](https://os-copilot.readthedocs.io/en/latest/tutorials/add_tool.html) | Adding and removing tools to the FRIDAY. |
| **Intermediate** | [Deploying API Services](https://os-copilot.readthedocs.io/en/latest/tutorials/deploy_api_service.html) | Demonstrate the deployment of API services for FRIDAY. |
| **Intermediate** | [Example: Automating Excel Tasks](https://os-copilot.readthedocs.io/en/latest/tutorials/example_excel.html) | Automating Excel control using FRIDAY. |
| **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. |
| **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. |
## 💻 User Interface (UI)
**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).
## 🏫 Community
Join our community to connect with other enthusiasts, researchers and developers:
- **[Discord](https://discord.com/invite/rXS2XbgfaD)**: Join our Discord server for real-time discussions and support.
- **[Twitter](https://twitter.com/oscopilot)**: Follow our Twitter to get latest new or tag us to share your demos!
## 👨💻 Contributing
**Visit [the roadmap](./docs/roadmap.md) to preview what the community is working on and become a contributor!**
## 🛡 Disclaimer
OS-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.
## 🔎 Citation
```
@article{wu2024copilot,
title={Os-copilot: Towards generalist computer agents with self-improvement},
author={Wu, Zhiyong and Han, Chengcheng and Ding, Zichen and Weng, Zhenmin and Liu, Zhoumianze and Yao, Shunyu and Yu, Tao and Kong, Lingpeng},
journal={arXiv preprint arXiv:2402.07456},
year={2024}
}
```
## 📬 Contact
If you have any inquiries, suggestions, or wish to contact us for any reason, we warmly invite you to email us at [email protected].
## Star History
