Plugin Template
^{LobeChat Plugin}

This is the plugin template for LobeChat plugin development

Changelog · Report Bug · Request Feature

Table of contents

TOC

• 🌟 Features
• 🤯 Usage
• ⌨️ Local Development
• 🤝 Contributing
• 🔗 Links

🌟 Features

• 💨 Quick start with low learning curve: This template provides a quick start option, allowing users to get started quickly. Additionally, the template includes detailed documentation to help users understand and use the features easily.
• 📚 Beautiful and comprehensive documentation: The template aims for aesthetics, with carefully designed interfaces and layouts that make the documentation more intuitive, readable, and user-friendly. Moreover, the template offers a wide range of styles and components for users to customize the appearance and functionality of their documentation.
• 🔄 Complete workflow, automatic publishing and partner updates: The template provides a complete workflow, including automatic publishing and automatic partner updates. Users can easily complete the publishing and updating tasks by following the specified steps.
• 🖱️ One-click document generation: The template offers a one-click document generation feature, allowing users to quickly generate complete documentation with simple operations. This saves users a significant amount of time and effort, allowing them to focus on improving the content and quality of their documentation.

🤯 Usage

Important

See detail on 📘 Template usage

Note

Plugins provide a means to extend the Function Calling capabilities of LobeChat. They can be used to introduce new function calls, and even new ways to render message results. If you are interested in plugin development, please refer to our 📘 Plugin Development Guide in the Wiki.

• @lobehub/lobe-chat-plugins: This is the plugin index for LobeChat. It accesses index.json from this repository to display a list of available plugins for LobeChat to the user.
• @lobehub/chat-plugin-sdk: The LobeChat Plugin SDK assists you in creating exceptional chat plugins for Lobe Chat.
• @lobehub/chat-plugins-gateway: The LobeChat Plugins Gateway is a backend service that serves as a gateway for LobeChat plugins. We deploy this service using Vercel. The primary API POST /api/v1/runner is deployed as an Edge Function.

Official Plugin	Description
SearchEngine	This plugin allows for the use of the SerpApi search engine.
RealtimeWeather	This plugin provides practical weather information by obtaining real-time weather data and can automatically update based on the user's location.
WebsiteCrawler	This plugin automatically crawls the main content of a specified URL webpage and uses it as context input.

⌨️ Local Development

You can use Github Codespaces for online development:

Or clone it for local development:

$ git clone https://github.com/lobehub/chat-plugin-template.git
$ cd chat-plugin-template
$ bun install
$ bun dev

🤝 Contributing

Contributions of all types are more than welcome, if you are interested in contributing plugin, feel free to show us what you’re made of.

🔗 Links

• 🤖 Lobe Chat - An open-source, extensible (Function Calling), high-performance chatbot framework. It supports one-click free deployment of your private ChatGPT/LLM web application.
• 🧩 / 🏪 Plugin Index - This is the plugin index for LobeChat. It accesses index.json from this repository to display a list of available plugins for Function Calling to the user.

---

📝 License

Copyright © 2023 LobeHub.
This project is MIT licensed.