168 lines
7.6 KiB
Markdown
168 lines
7.6 KiB
Markdown
[中文](README.1.zh.md) | [English](README.1.md)
|
|
|
|
|
|
## Introduction
|
|
|
|
HyperChat is an open-source chat client that supports MCP and can use various LLM APIs to achieve the best chat experience, as well as implement productivity tools.
|
|
|
|
[](https://github.com/BigSweetPotatoStudio/HyperChat/actions/workflows/build.yml)
|
|
[](https://www.npmjs.com/package/@dadigua/hyper-chat)
|
|
[](https://npm-stat.com/charts.html?package=@dadigua/hyper-chat)
|
|
|
|
* Supports OpenAI-style LLMs, `OpenAI`, `Claude`, `Claude(OpenAI)`, `Qwen`, `Deepseek`, `GLM`, `Ollama`, `xAI`, `Gemini`.
|
|
* Fully supports MCP.
|
|
|
|
## DEMO
|
|
|
|
* [HyperChat](https://hyperchat.dadigua.men/123456/) on Nodejs
|
|
* [Docker](https://htmivlknrjln.ap-northeast-1.clawcloudrun.com/123456/#/Chat) on ClawCloud
|
|
|
|
## Features:
|
|
|
|
- [x] **🪟Windows** + **🍏MacOS** + **Linux**
|
|
- [x] Command-line run, `npx -y @dadigua/hyper-chat`, default port 16100, password 123456, Web access http://localhost:16100/123456/
|
|
- [x] Docker
|
|
* Command-line version `docker pull dadigua/hyperchat-mini:latest`
|
|
* Ubuntu desktop + Chrome + BrowserUse version (**coming soon**)
|
|
- [x] `WebDAV` supports incremental synchronization, fastest synchronization through hash.
|
|
- [x] `HyperPrompt` prompt syntax supports variables (text + js code variables), basic syntax checking + Hover real-time preview.
|
|
- [x] `MCP` extensions
|
|
- [x] Supports dark mode🌙
|
|
- [x] Resources, Prompts, Tools support
|
|
- [x] Supports English and Chinese
|
|
- [x] Supports `Artifacts`, `SVG`, `HTML`, `Mermaid` rendering
|
|
- [x] Supports defining Agents, allowing preset prompts and selecting permitted MCP
|
|
- [x] Supports scheduled tasks, specifying Agents to complete tasks on schedule, and viewing task completion status.
|
|
- [x] Supports `KaTeX`, displays mathematical formulas, code rendering increases highlight and quick copy
|
|
- [x] Added `RAG`, based on MCP knowledge base
|
|
- [x] Introduced the ChatSpace concept, supports simultaneous chats across multiple dialogues
|
|
- [x] Supports chat model selection comparison
|
|
|
|
### TODO:
|
|
|
|
- Implement multi-Agent interactive system.
|
|
|
|
### LLM
|
|
|
|
| LLM | Usability | Remarks |
|
|
| -------- | ------ | ---------------------------- |
|
|
| claude | ⭐⭐⭐⭐⭐⭐ | No explanation |
|
|
| openai | ⭐⭐⭐⭐⭐ | Also perfectly supports multi-step function calls (gpt-4o-mini can also) |
|
|
| gemini flash 2.5 | ⭐⭐⭐⭐⭐ | Very easy to use |
|
|
| qwen | ⭐⭐⭐⭐ | Quite useful |
|
|
| doubao | ⭐⭐⭐ | Feels okay to use |
|
|
| deepseek | ⭐⭐⭐⭐ | Recently improved |
|
|
|
|
## Usage
|
|
|
|
* 1. Configure APIKEY, ensure your LLM service is compatible with OpenAI style.
|
|
* 2. Ensure you have `uv + nodejs` etc. installed in your system.
|
|
|
|
### [uvx & uv](https://github.com/astral-sh/uv)
|
|
|
|
Install using the command line, or check the official GitHub tutorial [uv](https://github.com/astral-sh/uv)
|
|
|
|
```
|
|
# MacOS
|
|
brew install uv
|
|
# Windows
|
|
winget install --id=astral-sh.uv -e
|
|
```
|
|
### [npx & nodejs](https://nodejs.org/en)
|
|
|
|
Install using the command line, or go to the official website to download, official site [nodejs](https://nodejs.org/en)
|
|
```
|
|
# MacOS
|
|
brew install node
|
|
# Windows
|
|
winget install OpenJS.NodeJS.LTS
|
|
```
|
|
|
|
## Development
|
|
|
|
```
|
|
cd electron && npm install
|
|
cd web && npm install
|
|
npm install
|
|
npm run dev
|
|
```
|
|
|
|
## HyperChat User Communication
|
|
|
|
* [Telegram](https://t.me/dadigua001)
|
|
* [QQ Group](https://qm.qq.com/cgi-bin/qm/qr?k=KrNWdu5sp7H3ves3ZPSd7ppKjQiPrAvZ&jump_from=webapi&authKey=xnW+Lcgk5KLh5NPh3lU0ddz9CFDbXgvjEy35wsYipUrCsqXFcqlvM5Yorh6jkGim)
|
|
|
|
#### Super input, supports variables (text + js code variables), basic syntax checking + Hover real-time preview
|
|
|
|
|
|
#### Chat supports model selection comparison
|
|
|
|
|
|
|
|
#### Supports clicking tool names for direct debugging
|
|
|
|
|
|
#### MCP calling Tool prompts + dynamically modifying LLM calling Tool parameters
|
|
|
|
|
|
#### Supports @ quick input + calling Agent
|
|
|
|
|
|
#### Supports rendering `Artifacts`, `SVG`, `HTML`, `Mermaid`
|
|
|
|
|
|
|
|
#### Supports MCP selection + selecting partial Tool
|
|
|
|
|
|
#### You can access from anywhere and any device via the web, and set a password
|
|
|
|
|
|
#### Calls terminal MCP to automatically analyze asar files + helps me unzip
|
|
|
|
|
|
#### Calls terminal, compiles and upgrades nginx
|
|
|
|
|
|
#### Gaode Map MCP
|
|
|
|
|
|
#### One-click webpage creation, and publish to (cloudflare)
|
|
|
|
|
|
#### Calls Google search, asks what the TGA Game of the Year is
|
|
|
|
|
|
#### What are the limited-time free games? Please visit the website to call the tool
|
|
|
|
|
|
#### Opens a webpage for you, analyzes the results, and writes to a file
|
|
|
|
|
|
#### Through web tools + command line tools, opens GitHub README to learn + GIT clone + set up development environment
|
|
|
|
|
|
#### Multi-chat Workspace + Night Mode
|
|
|
|
|
|
#### Scheduled task list + schedules messages to be sent to Agent to complete tasks
|
|
|
|
|
|
#### Install MCP from third parties (supports any MCP)
|
|
|
|
|
|
#### H5 interface
|
|
|
|
|
|
|
|
|
|
|
|
#### Testing model capabilities
|
|
|
|
|
|
#### Knowledge base
|
|
|
|
|
|
## Disclaimer
|
|
|
|
* This project is for learning and communication purposes only. If you use this project for any operations, such as crawling behavior, it has nothing to do with the developers of this project. |