kodaline / ts-cat

TypeScript version of the Cheshire Cat AI project

Cheshire Cat (Stregatto)

TypeScript version of the Cheshire Cat AI framework originally made in Python.

Check out the linked project for more information on what's being worked on.

📜 For the full list of changes, please read the changelog file.

👥 If you want to contribute, please read the contributing file.

📃 To be sure to respect everything, please read the code of conduct file.

Features

• Granular plugins folder reload
• Sync/Async ingestion endpoints
• New built-in LLMs and Embedders
• Instant tool call hook
• Granular management of procedures (forms and tools)
• Built-in CLI
• Supports multimodality

Pre-requisites

• Node.js 18.x
• pnpm 8.10.x

Installation

# (for development)
pnpm install
rm -f .git/hooks/pre-commit && ln -s ../../pre-commit .git/hooks/pre-commit

# (for production)
docker compose build --no-cache

How to run

# (for development)
pnpm run dev

# (for production)
docker compose up

How to test

To run the tests, be sure to have the Docker compose up and running. Then you can do:

docker exec -it ccat_ts pnpm test