https://github.com/oceanlvr/ChatGPT-ProBot

🤖️ A ChatGPT based GitHub robot. dialogue/CR/etc..
https://github.com/oceanlvr/ChatGPT-ProBot

chatgpt github-app github-robot probot robot

Last synced: about 1 month ago
JSON representation

🤖️ A ChatGPT based GitHub robot. dialogue/CR/etc..

• Host: GitHub
• URL: https://github.com/oceanlvr/ChatGPT-ProBot
• Owner: oceanlvr
• License: isc
• Created: 2022-12-05T04:15:18.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-10-08T22:44:11.000Z (about 1 year ago)
• Last Synced: 2024-10-29T21:10:33.436Z (about 1 month ago)
• Topics: chatgpt, github-app, github-robot, probot, robot
• Language: JavaScript
• Homepage: https://github.com/apps/chatgptbot
• Size: 946 KB
• Stars: 380
• Watchers: 7
• Forks: 89
• Open Issues: 44
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• Awesome-ChatGPT - ChatGPT-ProBot
• awesome-open-gpt - ChatGPT-ProBot
• awesome-chatgpt - A GPTChat based GitHub robot for dialogue, code reviews, etc.
• awesome-chatgpt - ChatGPT-ProBot
• StarryDivineSky - oceanlvr/ChatGPT-ProBot

README

        
# ChatGPT ProBot

[![Release Version](https://img.shields.io/github/release/oceanlvr/ChatGPTBot.svg)](https://github.com/oceanlvr/ChatGPTBot/releases/latest) [![Twitter](https://img.shields.io/twitter/follow/AdaMeta1?style=social)](https://twitter.com/AdaMeta1)

[![GitHub](https://img.shields.io/badge/github-%23121011.svg?style=for-the-badge&logo=github&logoColor=white)](https://github.com/apps/chatgptbot) [![Deploy to Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https://github.com/oceanlvr/ChatGPTBot)

A ChatGPT-based GitHub APP. Type `/chatgpt` to chat with robot 🤖️.

![hello](./assets/Hi.jpg)

Powered by [Probot](https://github.com/probot/probot) & [chatgpt-api](https://github.com/transitive-bullshit/chatgpt-api)

## Usage

**Try on [issue#1](https://github.com/oceanlvr/ChatGPT-ProBot/issues/1)**

**Try Review/Refactor on [PR#7](https://github.com/oceanlvr/ChatGPT-ProBot/pull/7)**

| event       | description                       | example                                 |

| ----------- | --------------------------------- | --------------------------------------- |

| `/ping`     | ping robot status                 |                                         |

| `/chatgpt`  | chat with bot on issue/PR comment | /chatgpt who are you?                   |

| `/review`   | auto review code in the PR        | /review fix the callback hell problem   |

| `/refactor` | refactor the code                 | /refactor fix the callback hell problem |

## Deploy your own APP

1. [Install & Configure the GitHub App](https://github.com/apps/chatgptbot)

2. Create `.env` file following `example.env`, please check config section in your [GitHub apps page](https://github.com/settings/apps)

    1. `APP_ID/PRIVATE_KEY/GITHUB_CLIENT_SECRET/GITHUB_CLIENT_ID` is required, please check [chatgptbot settings](https://github.com/settings/apps/chatgptbot) and fill them.

    2. **`PRIVATE_KEY` is required, it should be encoded by `base64`**.(`console.log(Buffer.from().toString('base64'))`).

    3. `SESSION_TOKEN` is required, it is generated by `ChatGPT` [website](https://chat.openai.com/chat). You can get it following [this step](https://github.com/transitive-bullshit/chatgpt-api#how-it-works).

3. Vercel Deploy (**recommend**), click [![Deploy to Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https://github.com/oceanlvr/ChatGPTBot) to clone deploy. Copy `.env` file environment to vercel app [environment-variables](https://vercel.com/docs/concepts/projects/environment-variables) in setting page (for me it's `https://vercel.com/oceanlvr/chatgptbot/settings/environment-variables`)

4. Edit the webhooks URL to `${vercelAPPURL}/api/github/webhooks`. For me it's 

5. Type `/chatgpt` in an issue, chat with the bot

*step4: update webhook URL to your vercel app domain.*

![webhooks](./assets/webhooks.jpg)

> **Note**

> This package will switch to using the official API once it's released.

## Dev

```sh

# Install dependencies

npm install

# Run the bot

npm dev

```

## License

[ISC](LICENSE) © 2022 oceanlvr