Content
# Telegram Search
[English](./README_EN.md) | [TODO](https://github.com/GramSearch/telegram-search/issues/23)
[](https://t.me/+Gs3SH2qAPeFhYmU9)
[](https://discord.gg/NzYsmJSgCT)
A powerful Telegram chat history search tool that supports vector search and semantic matching. Based on OpenAI's semantic vector technology, it makes your Telegram message retrieval smarter and more accurate.
## ⚠️ **Note**
- PRs are welcome!
- Using UserBot may carry the risk of account suspension, please use it with caution.
- As the project is in a rapid iteration phase, there may be database compatibility issues; it is recommended to back up your data regularly.
- To obtain an API key: [#111](https://github.com/GramSearch/telegram-search/issues/111)
## 🚀 Quick Start
### Installation Steps
1. Clone the repository:
```bash
git clone https://github.com/GramSearch/telegram-search.git
cd telegram-search
git checkout release
```
2. Install dependencies:
```bash
pnpm install
```
3. Configure the environment:
```bash
cp config/config.example.yaml config/config.yaml
```
4. Start the database container:
```bash
docker compose up -d
```
5. Initialize the database:
```bash
pnpm run db:migrate
```
6. Start the service:
```bash
# Start the backend service
pnpm run dev:server
# Start the frontend interface
pnpm run dev:frontend
```
Access `http://localhost:3333` to open the search interface.
## 🚀 Activity
[](https://star-history.com/#luoling8192/telegram-search&Date)

## 📝 License
MIT License © 2025
You Might Also Like
OpenWebUI
Open WebUI is an extensible web interface for customizable applications.

NextChat
NextChat is a light and fast AI assistant supporting Claude, DeepSeek, GPT4...

cherry-studio
Cherry Studio is a multilingual project for creative collaboration.

LibreChat
LibreChat is an open-source chat platform for seamless communication.

Continue
Continue is an open-source project for seamless server management.

repomix
Repomix packages your codebase into AI-friendly formats for easy use.