$git clone https://github.com/cheshire-cat-ai/core> [!WARNING] > Version 2 is unstable alpha! This new version is still under heavy development and needs work before it becomes stable. Expect breaking changes, rough edges, and incomplete features. Not recommended for production use yet.
| 1 | <a name="readme-top"></a> |
| 2 | |
| 3 | <p align="center"> |
| 4 | <img align="center" src=./readme/logo.svg width=200px alt="Cheshire Cat AI logo"> |
| 5 | </p> |
| 6 | |
| 7 | > [!WARNING] |
| 8 | > **Version 2 is unstable alpha!** This new version is still under heavy development and needs work before it becomes stable. Expect breaking changes, rough edges, and incomplete features. Not recommended for production use yet. |
| 9 | |
| 10 | # Cheshire Cat AI (Stregatto) |
| 11 | |
| 12 | Best framework to learn how AI agents work. |
| 13 | |
| 14 | It is designed bottom up to be easy to understand and easy to extend via vibe coding / agentic engineering. |
| 15 | |
| 16 | Main use case of the Cat is education & research. Many companies and institutions use it to publish agents on the web. |
| 17 | |
| 18 | Give the project a star ⭐ if you like creative cats! |
| 19 | |
| 20 | |
| 21 | ## Quickstart |
| 22 | |
| 23 | In an empty folder: |
| 24 | |
| 25 | ```bash |
| 26 | uv init --bare |
| 27 | uv add cheshire-cat-ai |
| 28 | uv run ccat |
| 29 | ``` |
| 30 | - UI on [localhost:1865](http://localhost:1865) |
| 31 | - REST API playground on [localhost:1865/docs](http://localhost:1865/docs) |
| 32 | |
| 33 | |
| 34 | ## Docs and Resources |
| 35 | |
| 36 | - [Official Documentation](https://cheshire-cat-ai.github.io/docs/) |
| 37 | - [Website](https://cheshirecat.ai/) |
| 38 | |
| 39 | |
| 40 | ## Roadmap & Contributing |
| 41 | |
| 42 | Roadmaps are for amateurs. |
| 43 | |
| 44 | If you have a proposal, open an issue and only do a PR if the issue is assigned to you. Read the [contributor guide](./readme/CONTRIBUTING.md). |
| 45 | |
| 46 | ## License and trademark |
| 47 | |
| 48 | Code is licensed under [GPL3](./LICENSE). |
| 49 | The Cheshire Cat AI logo and name are property of Piero Savastano (founder and maintainer). |
| 50 | |
| 51 | ## Which way to go? |
| 52 | |
| 53 | <p align="right">(<a href="#readme-top">back to top</a>)</p> |
| 54 | |
| 55 | <p align="center"> |
| 56 | <img align="center" src=./readme/cheshire-cat.jpeg width=400px alt="Wikipedia picture of the Cheshire Cat"> |
| 57 | </p> |
| 58 | |
| 59 | ``` |
| 60 | "Would you tell me, please, which way I ought to go from here?" |
| 61 | "That depends a good deal on where you want to get to," said the Cat. |
| 62 | "I don't much care where--" said Alice. |
| 63 | "Then it doesn't matter which way you go," said the Cat. |
| 64 | |
| 65 | (Alice's Adventures in Wonderland - Lewis Carroll) |
| 66 | |
| 67 | ``` |