Skip to content

lloorree/maze-extension

Repository files navigation

Extension Template for Chub

This is a template extension that does nothing, to be used as a base when developing extensions. Please clone it from GitHub to use as a template.

Latest Documentation

The latest documentation is at https://docs.chub.ai/docs/extensions.

Quickstart

You'll need node@21.7.1 and yarn installed. Then, to get started:

git clone https://github.com/CharHubAI/extension-template
cd extension-template
yarn install
yarn dev

The class you'll need to fill out and implement is in src/ChubExtension.tsx.

When running locally, as there is no chat UI/running chat, src/TestRunner.tsx is run. This only runs in development. Please modify it to test whatever you need.

This project uses GitHub actions to update the extension in Chub on commits to the main branch. For your project to do this, you'll need to get an extension auth token from the api.

Then in the GitHub project, go to Settings -> Secrets and Variables -> Actions -> Repository secrets -> New Repository Secret. Add the token with the name "CHUB_AUTH_TOKEN".

The use of an IDE like Intellij is very strongly recommended.

About

Demo extension for the Maze card.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published