https://github.com/cheshire-cat-ai/plugin-template

A generic template to create a plugin for the Cheshire Cat AI.
https://github.com/cheshire-cat-ai/plugin-template

awesome-plugin cheshire-cat llm plugins python template-project

Last synced: about 1 year ago
JSON representation

A generic template to create a plugin for the Cheshire Cat AI.

• Host: GitHub
• URL: https://github.com/cheshire-cat-ai/plugin-template
• Owner: cheshire-cat-ai
• Created: 2023-08-04T20:13:04.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-12-24T14:12:55.000Z (over 2 years ago)
• Last Synced: 2025-04-16T09:02:03.681Z (about 1 year ago)
• Topics: awesome-plugin, cheshire-cat, llm, plugins, python, template-project
• Language: Python
• Homepage: https://cheshire-cat-ai.github.io/docs/plugins-registry/plugin-from-template/
• Size: 36.1 KB
• Stars: 21
• Watchers: 4
• Forks: 16
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# My plugin

[![awesome plugin](https://custom-icon-badges.demolab.com/static/v1?label=&message=awesome+plugin&color=383938&style=for-the-badge&logo=cheshire_cat_ai)](https://)  

[![Awesome plugin](https://custom-icon-badges.demolab.com/static/v1?label=&message=Awesome+plugin&color=000000&style=for-the-badge&logo=cheshire_cat_ai)](https://)  

[![awesome plugin](https://custom-icon-badges.demolab.com/static/v1?label=&message=awesome+plugin&color=F4F4F5&style=for-the-badge&logo=cheshire_cat_black)](https://)

Write here all the useful information about your plugin.

This repository is the template to automate the release of official Cheshire Cat AI plugins. 

## Usage

1. Create a new repository clicking on the `Use this template` button.

2. Clone your new repo directly in the Cat's `plugins` folder.

3. Run the `setup.py` script:

```bash

python setup.py

```

The script will prompt you to write the name of your plugin and make an initial setup setting the name in the files.

4. Start developing!

> **Important**

> A new release of your plugin is triggered every time you set a new `version` in the `plugin.json` file.

> Please, remember to set it correctly every time you want to release an update.