cyberflamego / opencopilot Goto Github PK

OpenCopilot is a Python framework for building custom and private copilots.

Documentation: docs.opencopilot.dev

OpenCopilot is a Python framework for building custom and private copilots. It's designed to be fast to get started, extensible, and easy to use. Using OpenCopilot, you can see your copilot come live in 5 minutes, and making a fully functional copilot should take you less than a day.

Example Copilots built with OpenCopilot

• Ready Player Me Copilot which helps developers integrate RPM avatar SDK into their games.
• Unity Copilot which helps Unity developers debug, write code and speed up their development flow.

pip install opencopilot-ai

Into a Python file (for example, copilot.py), add:

from opencopilot import OpenCopilot

copilot = OpenCopilot()
copilot()

python copilot.py

That's it! The copilot is now running as an API service! 🎉 You can now chat with it: TODO how? (CLI, frontend, etc)

OpenCopilot by default helps you setup a Python API service for your copilot. That is intentional: we expect most people to integrate the functionality into their own application. However, if you want to setup a front-end for your copilot, we provide a working NextJS application out of the box. Follow the steps below to do so.

As a pre-requisite, you need to have pnpm installed.

First, clone the repo you're in: opencopilotdev/opencopilot:

git clone [email protected]:opencopilotdev/opencopilot.git

Then, setup the environment variables:

cd opencopilot/frontend
cp .env.example .env

Install the dependencies:

pnpm install

Run the front-end application:

pnpm run dev

You can now access the front-end at http://localhost:3001.

• Make the copilot yours: customize your copilot by prompting, adding context, etc.
• Read more about the core features and stack choices of OpenCopilot in Overview.

If you have any questions about OpenCopilot, feel free to do any of the following:

• Join our Discord and ask in the #support channel.
• Report bugs or feature requests in GitHub issues.
• Directly email Taivo, Co-founder & CTO of OpenCopilot: taivo [at] opencopilot.dev.