Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@lobehub/chat

Package Overview
Dependencies
Maintainers
2
Versions
1056
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@lobehub/chat

Lobe Chat is an open-source chatbot client using Vercel AI SDK, Typescript and Next.js

  • 0.76.2
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
13K
decreased by-10.32%
Maintainers
2
Weekly downloads
 
Created
Source

Lobe Chat

LobeChat is a open-source, extensible (Function Calling), high-performance chatbot framework.
It supports one-click free deployment of your private ChatGPT/LLM web application.

English · 简体中文 · Changelog · Report Bug · Request Feature

release releaseDate ciTest ciRelease
contributors forks stargazers issues

Deploy with Vercel

Table of contents
TOC

👋🏻 Getting Started & Join Our Community

Please be aware that LobeChat is currently under active development,feedback is welcome for any issues encountered.

No installation or registration necessary! Visit our website to experience it firsthand.
Join our Discord community! This is where you can connect with developers and other enthusiastic users of LobeHub.

⭐️ Star Us: You will receive all releases notifications from GitHub without any delay!

✨ Features

  • 💨 Quick Deployment: Using the Vercel platform, you can deploy with just one click and complete the process within 1 minute, without any complex configuration;
  • 💎 Exquisite UI Design: With a carefully designed interface, it offers an elegant appearance and smooth interaction. It supports light and dark themes and is mobile-friendly. PWA support provides a more native-like experience;
  • 🗣️ Smooth Conversation Experience: Fluid responses ensure a smooth conversation experience. It fully supports Markdown rendering, including code highlighting, LaTex formulas, Mermaid flowcharts, and more;
  • 🧩 Plugin Support & Custom Plugin Development: Conversations are extendable with plugins. Users can install and use various plugins, such as search engines, web extraction, etc. It also supports the development of custom plugins to meet custom needs;
  • 🔒 Privacy Protection: All data is stored locally in the user's browser, ensuring user privacy;
  • 🤖 Customizable Assistant Roles: Users can create, share, and debug personalized dialogue assistant roles according to their needs, providing more flexible and personalized dialogue functions;
  • 🌐 Custom Domain: If users have their own domain, they can bind it to the platform for quick access to the dialogue assistant from anywhere.
  • 🏬 Role Market: A Role Market is provided where users can select their preferred dialogue assistant roles, enriching the content and style of the dialogue;

👉 Roadmap: You can find our upcoming Roadmap plans in the Projects section.

🛳 Self Hosting

LobeChat provides a self-hosted version with Vercel. This allows you to build your own chatbot within a few minutes, without any prior knowledge. If you want to deploy this service yourself, you can follow these steps:

  • Prepare your OpenAI API Key.
  • Click the button below to start deployment: Deploy with Vercel. Log in directly with your Github account and remember to fill in the API Key and access code CODE on the environment variable page;
  • After deployment, you can start using it;
  • Bind a custom domain (optional): The DNS of the domain assigned by Vercel is polluted in some areas, binding a custom domain can connect directly.

Deploy with Vercel

Note
This project provides some additional configuration items, set with environment variables:

Environment VariableRequiredDescriptionExample
OPENAI_API_KEYYesThis is the API key you apply on the OpenAI account pagesk-xxxxxx...xxxxxx
OPENAI_PROXY_URLNoIf you manually configure the OpenAI interface proxy, you can use this configuration item to override the default OpenAI API request base URLhttps://api.chatanywhere.cn
The default value is
https://api.openai.com
ACCESS_CODENoAdd a password to access this service, the password should be a 6-digit number or letterawCT74 or e3@09!

Keep Updated

If you have deployed your own project following the one-click deployment steps in the README, you might encounter constant prompts indicating "updates available". This is because Vercel defaults to creating a new project instead of forking this one, resulting in an inability to accurately detect updates. We suggest you redeploy using the following steps, Maintaining Updates with LobeChat Self-Deployment.

📦 Ecosystem

NPMRepositoryDescriptionVersion
@lobehub/uilobehub/lobe-uiLobe UI is an open-source UI component library dedicated to building AIGC web applications.
@lobehub/lintlobehub/lobe-lintLobeLint provides configurations for ESlint, Stylelint, Commitlint, Prettier, Remark, and Semantic Release for LobeHub.
@lobehub/assetslobehub/assetsLogo assets, favicons, webfonts for LobeHub.

🧩 Plugins

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.

Note
The plugin system is currently undergoing significant development. You can expect to see it in https://github.com/lobehub/lobe-chat/issues/97.

  • @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 PluginDescription
SearchEngineThis plugin allows for the use of the SerpApi search engine.
RealtimeWeatherThis plugin provides practical weather information by obtaining real-time weather data and can automatically update based on the user's location.
WebsiteCrawlerThis plugin automatically crawls the main content of a specified URL webpage and uses it as context input.

⌨️ Local Development

You can use Gitpod for online development:

Open in Gitpod

Or clone it for local development:

$ git clone https://github.com/lobehub/lobe-chat.git
$ cd lobe-chat
$ pnpm install
$ pnpm dev

🤝 Contributing

Contributions of all types are more than welcome, if you are interested in contributing code, feel free to check out our GitHub Issues and Projects to get stuck in to show us what you’re made of.

📊 Total: 5

🔗 More Products

  • 🤯 Lobe Theme : The modern theme for stable diffusion webui, exquisite interface design, highly customizable UI, and efficiency boosting features.
  • 🌏 Lobe i18n : Lobe i18n is an automation tool for the i18n (internationalization) translation process, powered by ChatGPT. It supports features such as automatic splitting of large files, incremental updates, and customization options for the OpenAI model, API proxy, and temperature.
  • 💌 Lobe Commit : Lobe Commit is a CLI tool that leverages Langchain/ChatGPT to generate Gitmoji-based commit messages.


📝 License

Copyright © 2023 LobeHub.
This project is MIT licensed.

Keywords

FAQs

Package last updated on 11 Sep 2023

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc