LilyGPT

A Telegram Bot powered by ChatGPT
View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Setting Up
   • Telegram Bot Setup
   • OpenAI Setup
   • Application Setup
3. Usage
4. Roadmap
5. License
6. Acknowledgments

About The Project

LilyGPT is a Telegram Bot powered by ChatGPT

Using the OpenAI API, LilyGPT is able to generate text based on a prompt. The bot is able to generate text in a variety of different topics, such as names, descriptions, stories, etc.

By using this bot, you can interact with ChatGPT directly through Telegram, as a means of convenience and/or entertainment.

GPT 3.5 Compatible

This bot can be run on GPT 3.5, and utilizes Langchain to provide a similar experience to GPT 4. However, the responses may break from time to time due to 3.5 not wanting to follow instructions

The current tools available for Lily are

• Google Search (will use the top 3 results, using official Custom Search API)
• Web Scraper (will scrape websites for information required)
• Math (Using MathJS API)
• Time (Using Time API)

Built With

back to top

Getting Started

Prerequisites

• npm

  npm install
  

Setting Up

Telegram Bot Setup

If you already have a Telegram Bot's Token, you can skip here

OpenAI Setup

If you already have an OpenAI Token, you can skip here

1. Open the OpenAPI API Keys page and login to your account
2. Click on the "Create new secret key" button
3. Copy the secret key, and do not lose it. YOU WILL NOT BE ABLE TO SEE IT AGAIN

Remember to set "Usage Limits" if you are on a paid plan, to prevent unexpected billing

Application Setup

1. If not done, install the required packages using npm
2. Rename the .env.example into .env
3. Update the .env file with your Telegram Bot's Token and OpenAI Token accordingly
4. Rename .config.example into .config
5. Test the bot by typing ?name a cat for me in the channel you registered

back to top

Usage

• Type a prompt for the bot, starting with ?, such as ?name a cat for me

back to top

Roadmap

• Add OpenAI to the bot
• Add commands to control the bot
• Add more features
• Add support for multiple groups/chats
• Add Codex support
• Add Dall-E Support

back to top

License

Distributed under the MIT License. See LICENSE.md for more information.

back to top

Acknowledgments

• OpenAI
• Telegraf.js

back to top