diff --git a/README.md b/README.md index 9f0a2acb4..6cc991976 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ GitHub top language
- Logo + ## Production ready AI assistant framework @@ -28,50 +28,13 @@ 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: -- ๐ŸŒ Supports any language model (works with OpenAI chatGPT, LLAMA2, HuggingFace models, custom) -- ๐Ÿ˜ Rememebers conversations and documents and uses them in conversation -- ๐Ÿš€ Extensible via plugins (AI can connect to your APIs or execute custom python code) -- ๐Ÿ‹ Production Ready - 100% [dockerized](https://docs.docker.com/get-docker/) -- ๐Ÿ‘ฉโ€๐Ÿ‘งโ€๐Ÿ‘ฆ Active [Discord community](https://discord.gg/bHX5sNFCYU) and easy to understand [docs](https://cheshire-cat-ai.github.io/docs/) - -We are committed to openness, privacy and creativity, we want to bring AI to the long tail. If you want to know more about our vision and values, read the [Code of Ethics](./readme/CODE-OF-ETHICS.md). - -This project is growing fast, refactorings and code changes happens very often, join the [Issues](https://github.com/cheshire-cat-ai/core/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) to help! - -## Docs and Resources -- [Official Documentation](https://cheshire-cat-ai.github.io/docs/) -- [Discord Server](https://discord.gg/bHX5sNFCYU) -- [Website](https://cheshirecat.ai/) -- [YouTube tutorial - How to install](https://youtu.be/Rvx19TZBCrw) -- [Tutorial - Write your first plugin](https://cheshirecat.ai/write-your-first-plugin/) - ## Quickstart - -### Install - -To make Cheshire Cat run on your machine, you just need [`docker`](https://docs.docker.com/get-docker/) and [`docker compose`](https://docs.docker.com/compose/install/) installed. -Clone the repo: +To make Cheshire Cat run on your machine, you just need [`docker`](https://docs.docker.com/get-docker/) installed: ```bash -git clone https://github.com/cheshire-cat-ai/core.git cheshire-cat +docker run --rm -it -p 1865:80 ghcr.io/cheshire-cat-ai/core:latest ``` - -Enter the created folder: - -```bash -cd cheshire-cat -``` - -After that you can run: - -```bash -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:1865/admin](http://localhost:1865/admin). - You can also interact via REST API and try out the endpoints on [localhost:1865/docs](http://localhost:1865/docs) @@ -80,35 +43,24 @@ It can be done directly via the interface in the Settings page (top right in the Enjoy the Cat! -When you're done, remember to CTRL+c in the terminal and -``` -docker compose down -``` - -### Update - -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 -``` - -### Running Tests - -To run the tests within the Docker container, execute the following command: +## Docs and Resources -```bash -docker exec cheshire_cat_core python -m pytest --color=yes . -``` +- [Official Documentation](https://cheshire-cat-ai.github.io/docs/) +- [Discord Server](https://discord.gg/bHX5sNFCYU) +- [Website](https://cheshirecat.ai/) +- [YouTube tutorial - How to install](https://youtu.be/Rvx19TZBCrw) +- [Tutorial - Write your first plugin](https://cheshirecat.ai/write-your-first-plugin/) -### Try in GitHub Codespaces +## Why use the Cat -You can try Cheshire Cat in GitHub Codespaces. The free account provides 60 free hours a month. +- ๐ŸŒ Supports any language model (works with OpenAI chatGPT, LLAMA2, HuggingFace models, custom) +- ๐Ÿ˜ Rememebers conversations and documents and uses them in conversation +- ๐Ÿš€ Extensible via plugins (AI can connect to your APIs or execute custom python code) +- ๐Ÿ‹ Production Ready - 100% [dockerized](https://docs.docker.com/get-docker/) +- ๐Ÿ‘ฉโ€๐Ÿ‘งโ€๐Ÿ‘ฆ Active [Discord community](https://discord.gg/bHX5sNFCYU) and easy to understand [docs](https://cheshire-cat-ai.github.io/docs/) + +We are committed to openness, privacy and creativity, we want to bring AI to the long tail. If you want to know more about our vision and values, read the [Code of Ethics](./readme/CODE-OF-ETHICS.md). -[![Try in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/cheshire-cat-ai/core) ## Roadmap @@ -117,20 +69,12 @@ Whilst for the current progress of development, take a look at the [projects](ht ## Contributing +To get the full dev setup, follow [install instructions](https://cheshire-cat-ai.github.io/docs/quickstart/installation-configuration/). Send your pull request to the `develop` branch. Here is a [full guide to contributing](./readme/CONTRIBUTING.md). -To get started you can: -- Trying out the Cat -- Sharing on social media -- Join our [community on Discord](https://discord.gg/bHX5sNFCYU) -- Give the project a star โญ! - +Join our [community on Discord](https://discord.gg/bHX5sNFCYU) and give the project a star โญ! Thanks again!๐Ÿ™ -## Credits - -Logo image generated with MidJourney, prompted by [Edgars Romanovskis](https://www.linkedin.com/in/edgars-romanovskis-b28826259/) - ## Which way to go?

(back to top)