Skip to content

Commit

Permalink
simplify readme
Browse files Browse the repository at this point in the history
  • Loading branch information
pieroit committed Sep 27, 2023
1 parent fdd2228 commit 032493d
Showing 1 changed file with 13 additions and 35 deletions.
48 changes: 13 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,28 +21,21 @@

<br/>
<img src="./readme/cheshire_cat_generated_mj.jpeg" alt="Logo" width="600" height="auto" alt="Image generated by Midjourney, prompted by Edgars Romanovskis">
<h4>
Customizable AI architecture
</h4>
</div>

[![Try in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/cheshire-cat-ai/core)

## What is this?
## Production ready AI assistant framework

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
- 🚀 Extensible via plugins
- 🔧 Can use external tools (APIs, custom python code, other models)
- 📄 Can ingest documents (.pdf, .txt, .md)
- 🐋 100% [dockerized](https://docs.docker.com/get-docker/)
- 👩‍👧‍👦 Active [Discord community](https://discord.gg/bHX5sNFCYU)
- 🌍 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/)

If you want to know more about our vision and values, read the [Code of Ethics](./readme/CODE-OF-ETHICS.md). We are committed to openness, privacy and creativity, we want to bring AI to the long tail.
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!

Expand All @@ -58,7 +51,7 @@ This project is growing fast, refactorings and code changes happens very often,

### 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.
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:

```bash
Expand All @@ -74,11 +67,9 @@ cd cheshire-cat
After that you can run:

```bash
docker-compose up
docker compose up
```

> NOTE: if you have a later version of docker-compose, use the command `docker compose up` (without the dash). [REF.](https://stackoverflow.com/questions/66514436/difference-between-docker-compose-and-docker-compose)
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).
Expand All @@ -91,18 +82,18 @@ Enjoy the Cat!

When you're done, remember to CTRL+c in the terminal and
```
docker-compose down
docker compose down
```

### Update

From time to time it is a good idea to update the Cat:

```
docker-compose down
docker compose down
git pull origin main
docker-compose build --no-cache
docker-compose up
docker compose build --no-cache
docker compose up
```

### Running Tests
Expand All @@ -119,19 +110,6 @@ You can try Cheshire Cat in GitHub Codespaces. The free account provides 60 free

[![Try in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/cheshire-cat-ai/core)


#### Instructions

- Right-click this [link](https://codespaces.new/cheshire-cat-ai/core) and select "open a new window." It will open a webpage titled "Create a new codespace":
- You can ignore the options on the screen and press the green button "create codespace"
- Wait for the codespace to load, and then type on the terminal "docker-compose up"
- It will take a few minutes. When you read "Application startup complete," it will show three links: REST API, PUBLIC, and ADMIN.
- Click on the ADMIN link to configure Cheshire Cat and start playing with it.
- Have fun!
- As soon as you're satisfied, you can press "CTRL C" on the terminal to stop the Cheshire Cat. Then type docker-compose down to close the docker container.

<p align="right">(<a href="#readme-top">back to top</a>)</p>

## Roadmap

Detailed roadmap is [here](./readme/ROADMAP.md).
Expand Down

0 comments on commit 032493d

Please sign in to comment.