Skip to content

Commit

Permalink
feat: update README, DESCRIPTION and CHANGELOG
Browse files Browse the repository at this point in the history
  • Loading branch information
LiLittleCat committed Mar 21, 2023
1 parent 21a755f commit 1566754
Show file tree
Hide file tree
Showing 11 changed files with 110 additions and 45 deletions.
10 changes: 10 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,16 @@

## [Unreleased]

### Added

- Add third-party mirror websites for free using.
- Support all future IDE builds [#12](https://github.com/LiLittleCat/intellij-chatgpt/pull/12)

### Fixed

- Remove session token storage to avoid cookie setting problems [#16](https://github.com/LiLittleCat/intellij-chatgpt/issues/16)
- Change the Tool Window name to `ChatGPT Tool` [#10](https://github.com/LiLittleCat/intellij-chatgpt/issues/10)

## [1.0.3] - 2023-02-20
- Fix bugs

Expand Down
36 changes: 20 additions & 16 deletions DESCRIPTION.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,39 @@

<!-- Plugin description -->

A [ChatGPT](https://chat.openai.com/) plugin for IntelliJ Platform-Based IDEs.
This Jetbrains IDEs plugin integrates [ChatGPT](https://chat.openai.com/) and [other third-party mirror websites](https://github.com/LiLittleCat/awesome-free-chatgpt) of ChatGPT into JetBrains IDEs,
providing a seamless experience for developers to interact with the ChatGPT AI model directly within their development environment.

### Feature

🚀 Easy to use, without annoyingly token copy, just login once and you are ready to go.
- 🚀 Easy to use, interact with ChatGPT without leaving the IDE.
- 🆓 Integrates free third-party mirror websites and easily update.
- ✅ Add and manage multiple ChatGPT URLs.
- 🔄 Easily switch between different ChatGPT URLs.

### Usage
### How it works

1. Register a [OpenAI](https://beta.openai.com/signup) account.
2. Open tool window "ChatGPT", login is required for the first time.
3. Just ask ChatGPT anything you want.

[Github](https://github.com/LiLittleCat/intellij-chatgpt)
This plugin uses JCEF(Java Chromium Embedded Framework) to render the content. It is a lightweight and cross-platform web browser engine that is built on top of Chromium and is used by IntelliJ IDEA to render the HTML content of the IDE.
JCEF is supported in IntelliJ IDEA 2020.2 and later. See [JCEF](https://plugins.jetbrains.com/docs/intellij/jcef.html) for more information.

Feel free to submit [issue](https://github.com/LiLittleCat/awesome-free-chatgpt/issues) and [PRs](https://github.com/LiLittleCat/awesome-free-chatgpt/pulls). If you find it useful, welcome to star ⭐, your support is my motivation to move forward.

---
一个适合所有 JetBrains IDE 的 [ChatGPT](https://chat.openai.com/) 插件。

### 特点
一个将 [ChatGPT](https://chat.openai.com/)[其他第三方镜像网站](https://github.com/LiLittleCat/awesome-free-chatgpt) 整合到 JetBrains IDEs 的插件。

🚀 简单快捷,无需烦人的 token 复制,只需登录一次就可以使用。
### 功能

### 使用
- 🚀 易于使用,无需离开 IDE 即可与 ChatGPT 交互。
- 🆓 集成免费的第三方镜像网站,并且更新方便。
- ✅ 添加和管理多个 ChatGPT URL。
- 🔄 轻松在不同的 ChatGPT URL 之间切换。

1. 注册一个 [OpenAI](https://beta.openai.com/signup) 账户。
2. 打开工具窗口 "ChatGPT",第一次使用时需要登录。
3. 输入你想问的问题。
### 如何工作的

此插件使用 JCEF(Java Chromium Embedded Framework)来渲染内容。它是一个轻量级且跨平台的基于 Chromium 的网络浏览器引擎,被 IntelliJ IDEA 用于渲染 IDE 的 HTML 内容。
JCEF 支持 IntelliJ IDEA 2020.2 及更高版本。有关更多信息,请参阅 [JCEF](https://plugins.jetbrains.com/docs/intellij/jcef.html)

[Github](https://github.com/LiLittleCat/intellij-chatgpt)
欢迎随时提交 [issue](https://github.com/LiLittleCat/awesome-free-chatgpt/issues)[PRs](https://github.com/LiLittleCat/awesome-free-chatgpt/pulls),如果您觉得有用,欢迎 star ⭐,您的支持是我前进的动力。

<!-- Plugin description end -->
50 changes: 38 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,28 @@

[中文说明](README_CN.md)

A [ChatGPT](https://chat.openai.com/) plugin for IntelliJ Platform-Based IDEs.
This Jetbrains IDEs plugin integrates [ChatGPT](https://chat.openai.com/) and [other third-party mirror websites](https://github.com/LiLittleCat/awesome-free-chatgpt) of ChatGPT into JetBrains IDEs,
providing a seamless experience for developers to interact with the ChatGPT AI model directly within their development environment.

## Feature

🚀 Easy to use, without annoyingly token copy, just login once and you are ready to go.
- 🚀 Easy to use, and interact with ChatGPT without leaving the IDE.
- 🆓 Integrates free third-party mirror websites and easily update.
- ✅ Add and manage multiple ChatGPT URLs.
- 🔄 Easily switch between different ChatGPT URLs.

## How it works

This plugin uses JCEF(Java Chromium Embedded Framework) to render the content. It is a lightweight and cross-platform web browser engine that is built on top of Chromium and is used by IntelliJ IDEA to render the HTML content of the IDE.
JCEF is supported in IntelliJ IDEA 2020.2 and later. See [JCEF](https://plugins.jetbrains.com/docs/intellij/jcef.html) for more information.

## Installation

- Using IDE built-in plugin system:

<kbd>Settings/Preferences</kbd> > <kbd>Plugins</kbd> > <kbd>Marketplace</kbd> > <kbd>Search for "ChatGPT Tool"</kbd> >
<kbd>Install Plugin</kbd>

- Manually:

Download the [latest release](https://github.com/LiLittleCat/intellij-chatgpt/releases/latest) and install it manually using
Expand All @@ -29,13 +38,30 @@ A [ChatGPT](https://chat.openai.com/) plugin for IntelliJ Platform-Based IDEs.

## Usage

1. Register a [OpenAI](https://beta.openai.com/signup) account.
2. Open tool window "ChatGPT", login is required for the first time:
![](/image/login.png)
3. Just ask ChatGPT anything you want:
![](/image/use.png)
1. Open the tool window "ChatGPT Tool", it will open the default ChatGPT URL
![](/image/login.png)
2. If you use [official ChatGPT](https://chat.openai.com/) as default, you can register a [OpenAI](https://beta.openai.com/signup) account and log in.
![](/image/use.png)
3. Open the setting to change the default ChatGPT URL or add more URLs.
![](/image/settings-info.png)
explanation:
1. Open the setting quickly.
2. Refresh the opened page.
3. Add a new URL to the tool window.
4. Open the author's GitHub page in Browser.
5. Open other plugins from the author in Browser.
6. Select the default URL, default URL will be opened when you first open the tool window and when you close all opened pages.
7. URL list, you can add, edit, and delete the URL list.
8. Add a new URL.
![](/image/add-tab.png)
9. Delete the selected URL.
10. Fetch the URL list from [the author's other GitHub repository](https://github.com/LiLittleCat/awesome-free-chatgpt).
4. Use third-party mirror websites.
![](/image/another.png)

> **Note**
After your login, your session token is saved in Settings. The first time uses it, you can set it with a valid session token so that you don't have to log in. You can also copy this session token for other usages, like using another ChatGPT client who requires a token.
> ![](/image/settings.png)

> **Notice**
>
> Cannot log in to the official ChatGPT by Google account or Microsoft account is not caused by this plugin, but by the official ChatGPT itself.
>
> See https://github.com/LiLittleCat/intellij-chatgpt/issues/7 and https://github.com/JetBrains/jcef/issues/14 for more information.
49 changes: 37 additions & 12 deletions README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,21 @@
[![Version](https://img.shields.io/jetbrains/plugin/v/20629-chatgpt-tool.svg)](https://plugins.jetbrains.com/plugin/20629-chatgpt-tool)
[![Downloads](https://img.shields.io/jetbrains/plugin/d/20629-chatgpt-tool.svg)](https://plugins.jetbrains.com/plugin/20629-chatgpt-tool)

一个适合所有 JetBrains IDE 的 [ChatGPT](https://chat.openai.com/) 插件。
[English](README.md)

## 特点
一个将 [ChatGPT](https://chat.openai.com/)[其他第三方镜像网站](https://github.com/LiLittleCat/awesome-free-chatgpt) 整合到 JetBrains IDEs 的插件。

🚀 简单快捷,无需烦人的 token 复制,只需登录一次就可以使用。
## 功能

- 🚀 易于使用,无需离开 IDE 即可与 ChatGPT 交互。
- 🆓 集成免费的第三方镜像网站,并且更新方便。
- ✅ 添加和管理多个 ChatGPT URL。
- 🔄 轻松在不同的 ChatGPT URL 之间切换。

## 如何工作的

此插件使用 JCEF(Java Chromium Embedded Framework)来渲染内容。它是一个轻量级且跨平台的基于 Chromium 的网络浏览器引擎,被 IntelliJ IDEA 用于渲染 IDE 的 HTML 内容。
JCEF 支持 IntelliJ IDEA 2020.2 及更高版本。有关更多信息,请参阅 [JCEF](https://plugins.jetbrains.com/docs/intellij/jcef.html)

## 安装

Expand All @@ -25,16 +35,31 @@
<kbd>Settings/Preferences</kbd> > <kbd>Plugins</kbd> > <kbd>⚙️</kbd> > <kbd>Install plugin from disk...</kbd>
手动安装。

## 使用
## 使用方法

1. 注册一个 [OpenAI](https://beta.openai.com/signup)
账户。注册教程:https://mirror.xyz/boxchen.eth/9O9CSqyKDj4BKUIil7NC1Sa1LJM-3hsPqaeW_QjfFBc
2. 打开工具窗口 "ChatGPT", 第一次使用时需要登录:
1. 打开 "ChatGPT Tool" 工具窗口,它将打开默认的 ChatGPT URL。
![](/image/login.png)
3. 输入你想问的问题:
2. 如果您将 [官方 ChatGPT](https://chat.openai.com/) 设置为默认,您可以注册一个 [OpenAI](https://beta.openai.com/signup) 账户并登录。
![](/image/use.png)
3. 打开设置以更改默认的 ChatGPT URL 或添加更多 URL。
![](/image/settings-info.png)
说明:
1. 快速打开设置。
2. 刷新已打开的页面。
3. 向工具窗口添加新的 URL。
4. 在浏览器中打开作者的 GitHub 页面。
5. 在浏览器中打开作者的其他插件。
6. 选择默认 URL,当您首次打开工具窗口和关闭所有已打开的页面时,将打开默认 URL。
7. URL 列表,您可以添加、编辑和删除 URL 列表。
8. 添加新的 URL。
![](/image/add-tab.png)
9. 删除选定的 URL。
10.[作者的另一个 GitHub 仓库](https://github.com/LiLittleCat/awesome-free-chatgpt) 获取 URL 列表。
4. 使用第三方镜像网站。
![](/image/another.png)

> **Note**
> 登录后,session token 会被保存在设置中。在第一次使用时,你可以设置一个有效的 session token ,这样就不需要登录了。
> 也可以复制这个 session token 用于其他用途,比如使用其他需要 session token 的 ChatGPT 客户端。
> ![](/image/settings.png)
> **注意**
>
> 无法使用 Google 账户或 Microsoft 账户登录官方 ChatGPT 不是由于此插件造成的,而是由官方 ChatGPT 本身造成的。
>
> 有关更多信息,请参阅 https://github.com/LiLittleCat/intellij-chatgpt/issues/7https://github.com/JetBrains/jcef/issues/14
10 changes: 5 additions & 5 deletions gradle.properties
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ pluginGroup = com.lilittlecat.intellij-chatgpt
pluginName = ChatGPT Tool
pluginRepositoryUrl = https://github.com/LiLittleCat/intellij-chatgpt
# SemVer format -> https://semver.org
pluginVersion = 1.0.3
pluginVersion = 1.1.0

# Supported build number ranges and IntelliJ Platform versions -> https://plugins.jetbrains.com/docs/intellij/build-number-ranges.html
pluginSinceBuild = 202
Expand All @@ -28,7 +28,7 @@ kotlin.stdlib.default.dependency = false
# Enable Gradle Configuration Cache -> https://docs.gradle.org/current/userguide/configuration_cache.html
org.gradle.unsafe.configuration-cache = true

systemProp.https.proxyHost=127.0.0.1
systemProp.https.proxyPort=7890
systemProp.http.proxyHost=127.0.0.1
systemProp.http.proxyPort=7890
#systemProp.https.proxyHost=127.0.0.1
#systemProp.https.proxyPort=7890
#systemProp.http.proxyHost=127.0.0.1
#systemProp.http.proxyPort=7890
Binary file added image/add-tab.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added image/another.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added image/fetch-url.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified image/login.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added image/settings-info.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified image/use.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 1566754

Please sign in to comment.