OS-Copilot: Towards Generalist Computer Agents with Self-Improvement

[Website] [PDF] [Documentation] [Twitter] [Discord]

⚡️ Quickstart

1. Clone the GitHub Repository:

   git clone https://github.com/OS-Copilot/OS-Copilot.git
   

2. Set Up Python Environment: Ensure you have a version 3.10 or higher Python environment. You can create and activate this environment using the following commands, replacing oscopilot_env with your preferred environment name:

   conda create -n oscopilot_env python=3.10 -y
   conda activate oscopilot_env
   

3. Install Dependencies: Move into the OS-Copilot directory and install the necessary dependencies by running:

   cd OS-Copilot
   pip install -e .
   

4. Set OpenAI API Key: Configure your OpenAI API key in .env and select the model you wish to use.

5. Running the Script: Run the quick_start.py script, simply execute the following command in your terminal:

   python quick_start.py
   

* FRIDAY currently only supports single-round conversation.

🛠️ Tutorial

Level	Tutorial	Description
Beginner	Installation	Provides three methods to install FRIDAY: cloning from GitHub, development setup via pip install -e ., and direct pip installation.
Beginner	Getting Started	Demonstrates how to use FRIDAY with a quick_start.py script, covering module imports, configuration setup, and task execution.
Intermediate	Adding Your Tools	Outlines the process for adding and removing tools to the FRIDAY.
Intermediate	Deploying API Services	Explains the deployment of API services for FRIDAY, including environment setup, configuring API tools, and launching the server.
Intermediate	Example: Automating Excel Tasks	Demonstrates automating Excel tasks with FRIDAY, including formula application and chart creation within an Excel sheet.
Intermediate	Enhancing FRIDAY with Self-Learning for Excel Task Automation	Showcases empowering FRIDAY with self-learning to autonomously learn and execute Excel file manipulations.
Advanced	Designing New API Tools	Guides on designing, integrating, and deploying custom API tools for FRIDAY to extend its functionalities.

🏫 Community

Join our community to connect with other enthusiasts, share your tools and demos, and collaborate on innovative projects. Stay engaged and get the latest updates by following us:

• Discord: Join our Discord server for real-time discussions, support, and to share your work with the community. Click here to join: Discord Server.
• Twitter: Follow us on Twitter @oscopilot for the latest news, updates, and highlights from our community.

👨‍💻‍ Contributors

🛡 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

@misc{wu2024oscopilot,
      title={OS-Copilot: Towards Generalist Computer Agents with Self-Improvement}, 
      author={Zhiyong Wu and Chengcheng Han and Zichen Ding and Zhenmin Weng and Zhoumianze Liu and Shunyu Yao and Tao Yu and Lingpeng Kong},
      year={2024},
      eprint={2402.07456},
      archivePrefix={arXiv},
      primaryClass={cs.AI}
}

📬 Contact

If 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.