Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Ciyou/chatbot-telegram
Yet another telegram ChatGPT bot which allows you to setup and run your bot with one simple command.
https://github.com/Ciyou/chatbot-telegram
chatgpt telegram-bot
Last synced: 3 months ago
JSON representation
Yet another telegram ChatGPT bot which allows you to setup and run your bot with one simple command.
- Host: GitHub
- URL: https://github.com/Ciyou/chatbot-telegram
- Owner: Ciyou
- License: mit
- Created: 2022-12-08T19:36:38.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-03-05T19:22:45.000Z (almost 2 years ago)
- Last Synced: 2024-08-01T22:41:25.751Z (6 months ago)
- Topics: chatgpt, telegram-bot
- Language: TypeScript
- Homepage:
- Size: 71.3 KB
- Stars: 44
- Watchers: 2
- Forks: 18
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-chatgpt - chatbot-telegram
README
🤖️ chatbot-telegram
> Yet another telegram ChatGPT bot which allows you to setup and run your bot with one simple command. PRs and suggestions are welcome. Leave a 🌟 if you find this project helpful.
> ⚠️ Warning: The underlying model is currently `gpt-3.5-turbo`, which is already fine-tuned for conversation **but costs money**. *A new OpenAI account comes with $18 free credit though, which is enough to run this bot for some time.*
> Support for using a reverse proxy to access the origin ChatGPT will be added soon.
## 🪄 Features
- [x] Run your ChatGPT telegram bot with single command.
- [x] Support group chat by metioning `@` bot while `bot privacy mode` turned off.
- [x] Reload conversion with `/reload` command.
- [ ] Support group chat with `/chat` command while `bot privacy mode` turned on.
- [ ] Support multiple conversions, unique for each chatID.
- [ ] Support login to OpenAI with password.
## 💿 Installation
1. Make sure you have installed `Deno` already.
If you don't, follow this official document to install. https://deno.land/[email protected]/getting_started/installation#download-and-install
2. Simply `git clone` or download this repo, `cd` into the project folder.
3. Cache dependencies and check integrity with `lock.json`, *you only need to do this once*.
```
deno cache --lock=lock.json chatbot.ts
```
## 🔮 Usage
1. Complete Telegram bot token and ChatGPT session token in `env.example`.
```
BOT_TOKEN=YOUR_BOT_TOKEN
OPENAI_API_KEY=YOUR_OPENAI_API_KEY
```
To get your session token, see [Get ChatGPT Session Token](#-get-chatgpt-session-token).
2. Rename `env.example` to `.env`
```
mv env.example .env
```
3. `deno run` and enjoy!
```
deno run chatbot.ts
```
Deno requires you to approve file system reading, enviroment variables access and network access manually.
You can also run with these parammeters to give permission by default.
```
deno run --allow-read --allow-env --allow-net chatbot.ts
```
## 🔑 Get OpenAI API Key
1. Sign up for an OpenAI account at https://beta.openai.com/signup
2. Generate a new API key at https://platform.openai.com/account/api-keys. This is your API key, anyone can use it to access your account which may cause unexpected charges. Keep it secret!
3. Paste it in your `.env` file.
## 💌 Credits
- [chatgpt-api](https://github.com/transitive-bullshit/chatgpt-api) Node.js client for the unofficial ChatGPT API. - [License](https://github.com/transitive-bullshit/chatgpt-api/blob/main/license)
- [node-telegram-bot-api](https://github.com/yagop/node-telegram-bot-api) Telegram Bot API for NodeJS. - [License](https://github.com/yagop/node-telegram-bot-api/blob/master/LICENSE.md)
- [Lodash](https://github.com/lodash/lodash) - [License](https://github.com/lodash/lodash/blob/master/LICENSE)
- One-third of final code & almost all the comments was written by [Github Copilot](https://github.com/features/copilot). How far are we from the day where AI build whole project itself with AI 👀