The Cheshire Cat is a framework to build custom AIs on top of any language model. If you ever used systems like WordPress or Django to build web apps, imagine the Cat as a similar tool, but specific for AI.
Why use the Cat:
- 🌍 Language model agnostic (works with OpenAI, Cohere, HuggingFace models, custom)
- 🐘 Long term memory
- 🚀 Extendible via plugins
- 🔧 Can use external tools (APIs, custom python code, other models)
- 📄 Can ingest documents (.pdf, .txt, .md)
- 🐋 100% dockerized
- 👩👧👦 Active Discord community
If you want to know more about our vision and values, read the Code of Ethics. We are committed to openness, privacy and creativity, we want to bring AI to the long tail.
This project is growing fast, refactorings and code changes happens very often, join the Issues to help!
You just need docker and docker-compose installed on your system.
Clone the repo:
git clone https://github.com/cheshire-cat-ai/core.git cheshire-catEnter the created folder:
cd cheshire-catAfter that you can run:
docker-compose upNOTE: if you have a later version of docker-compose, use the command
docker compose up(without the dash). REF.
The first time (only) it will take several minutes, as the images occupy a few GBs.
- Chat with the Cheshire Cat on localhost:1865/admin.
- You can also interact via REST API and try out the endpoints on localhost:1865/docs
As a first thing, the Cat will ask you to configure your favourite language model. It can be done directly via the interface in the Settings page (top right in the admin).
Enjoy the Cat!
When you're done, remember to CTRL+c in the terminal and
docker-compose down
From time to time it is a good idea to update the Cat:
docker-compose down
git pull origin main
docker-compose build --no-cache
docker-compose up
Detailed roadmap is here. Whilst for the current progress of development, take a look at the projects marked as open.
Here is a full guide to contributing.
You can start by:
- Trying out the Cat
- Sharing on social media
- Join our community on Discord
- Give the project a star ⭐!
Thanks again!🙏
Logo image generated with MidJourney, prompted by Edgars Romanovskis
"Would you tell me, please, which way I ought to go from here?"
"That depends a good deal on where you want to get to," said the Cat.
"I don't much care where--" said Alice.
"Then it doesn't matter which way you go," said the Cat.
(Alice's Adventures in Wonderland - Lewis Carroll)