dariscappelletti / cheshire-cat

Open source and customizable AI architecture

Cheshire-Cat (Stregatto)

Customizable AI architecture

What is this?

If you want to build a custom AI on top of a language model, the Cat can help you:

• Language model agnostic (works with OpenAI, Cohere, HuggingFace models, custom)
• Long term memory
• Can use external tools (APIs, custom python code, other models)
• Can ingest documents (.pdf, .txt)
• Extendible via plugins
• 100% dockerized

"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)

Quickstart

You just need docker and docker-compose installed on your system. Clone the repo and cd into it. Create a .env file containing:

OPENAI_KEY=<your-openai-key>

After that you can run:

docker-compose up

The first time (only) it will take several minutes, as the images occupy a few GBs.

• Chat with the Cheshire Cat on localhost:3000.
• You can also interact via REST API and try out the endpoints on localhost:1865/docs

When you're done, remember to CTRL+c in the terminal and

docker-compose down

(back to top)

Docs and Resources

• YouTube Presentation: Meet the CHESHIRE CAT - Open Source AI

Roadmap

• QA / tests
• docs and tutorials
• online demo
• voice interface
• more plugins shipped by default
• (surprise!!!) PURR

Contributing

If you have a suggestion that would make this better, open an issue and we can reason about it. If you want to contribute code, fork the repo and create a pull request.

1. Try out the Cat
2. Fork the Project
3. Create your Feature Branch (git checkout -b feature/AmazingFeature)
4. Commit your Changes (git commit -m 'Add some AmazingFeature')
5. Push to the Branch (git push origin feature/AmazingFeature)
6. Open a Pull Request ((if it contains lots of code, please discuss it beforehand opening a issue))

You can start simply by:

• Making tutorials and docs
• Sharing on social media

Don't forget to give the project a star!⭐ Thanks again!🙏

(back to top)