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.

Leveraging OS-Copilot, we built FRIDAY, a self-improving AI assistant capable of solving general computer tasks.

⚡️ Quickstart

Clone the GitHub Repository:

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

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
```
Install Dependencies: Move into the OS-Copilot directory and install the necessary dependencies by running:
```
cd OS-Copilot
pip install -e .
```
Set OpenAI API Key: Configure your OpenAI API key in .env and select the model you wish to use.
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.

🛠️ FRIDAY-Gizmos

We maintain an open-source library of toolkits for FRIDAY, which includes tools that can be directly utilized within FRIDAY. For a detailed list of tools, please see FRIDAY-Gizmos. The usage methods are as follows:

Find the tool you want to use in FRIDAY-Gizmos and download its tool code.
Add the tool to FRIDAY's toolkit:

python friday/tool_repository/manager/tool_manager.py --add --tool_name [tool_name] --tool_path [tool_path]

If you wish to remove a tool, you can run:

python friday/tool_repository/manager/tool_manager.py --delete --tool_name [tool_name]

💻 User Interface (UI)

Enhance Your Experience with Our Intuitive Frontend! This interface is crafted for effortless control of your agents. For more details, visit FRIDAY Frontend.

✨ Deploy API Services

For comprehensive guidelines on deploying API services, please refer to the OS-Copilot documentation.

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

README.md Unescape Escape

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

📖 Overview