GPT-Shell is an OpenAI based chat-bot that is similar to OpenAI's ChatGPT (https://chat.openai.com/).

It allows users to converse with a virtual companion. It uses nodejs and typescript, as well as modern yarn, to create a seamless conversation experience.

You can try the bot on the official Discord server:

Set up a discord bot and add it to your server.

Follow the setup instructions below.

To interact with GPT-Shell, users can:

• Use the /chat-gpt command to start a conversation with the bot
• Ping the bot in a channel it's in
• Message the bot directly

The /chat-gpt command will start a new conversation thread, and whenever the user types something, the bot will respond.

The bot is able to handle multiple conversations at once, so you can start as many conversations as you like.

Nodejs: https://nodejs.org/en/ (18 or above) Yarn: https://nodejs.org/en/ (after installing nodejs)

To use GPT-Shell, you will need to:

• Clone the project
• Open the terminal in the project's folder
  • (in windows, right click somewhere in the folder and select "Open In Terminal")
  • if you see something about powershell, type cmd and hit enter, to go to the simpler command line terminal.
• Run yarn install

You can also fork the replit:

https://replit.com/@Ephemeros/GPT-Shell

Set up the environment variables as described below.

Then to start a development environment, run yarn dev. To build and run, run yarn build and then yarn start.

The following environment variables are required for GPT-Shell to work properly.

MongoDB:

• MONGODB_URI: The MongoDB connection string.
  • Should look something like this: mongodb+srv://:..mongodb.net/?retryWrites=true&w=majority
• DB_NAME: The name of the collection in MongoDB

Bot Token:

• BOT_TOKEN: The Discord bot token
  • You can get it by following https://discord.com/developers/applications then selecting your app and then selecting "Bot".

Commands:

• COMMAND_NAME: The name of the chat-gpt command
• API_KEY_COMMAND_NAME: The name of the chat-gpt-openai-api-key command (if you want users to add the bot to their server)

OpenAI API Key:

• OPENAI_API_KEY: The API key for your OpenAI account

Discord Server Details:

• MAIN_SERVER_ID: The Discord server where the bot lives
• LOG_CHANNEL_ID: (Optional) The channel for log messages
• MAIN_SERVER_INVITE: (Optional) The ideally non-expiring server invite link (if you want users to add the bot to their server)
• USE_SAME_API_KEY_FOR_ALL: (Optional) When set to 'true', it will allow any server or user to use the bot without needing to provide their own API keys.

You can set the environment variables in any way you like, or place an .env.local file at the root of your project, next to package.json, that looks like this:

# MongoDB:
MONGODB_URI=
DB_NAME=

# Bot Token:
BOT_TOKEN=

# Commands:
COMMAND_NAME=chat-gpt
# API_KEY_COMMAND_NAME=chat-gpt-openai-api-key # enable this if you want the bot to be installed in other servers.

# OpenAI API Key:
OPENAI_API_KEY=

# Discord Server Details:
MAIN_SERVER_ID=
LOG_CHANNEL_ID=
MAIN_SERVER_INVITE=
USE_SAME_API_KEY_FOR_ALL=

We welcome contributions to GPT-Shell. If you have an idea for a new feature or have found a bug, please open an issue on GitHub. We would also appreciate any sponsorships or donations.

You can sponsor us through our GitHub sponsor page here.

GPT-Shell is released under the MIT License.