Skip to content

Commit

Permalink
Doc: 友情链接与python版本说明
Browse files Browse the repository at this point in the history
Fixes #46
  • Loading branch information
xiaoxx-mac committed May 19, 2023
1 parent c5b1a1a commit 1d97114
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 1 deletion.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,12 @@ Supports saving chat messages to a JSON file and loading them from the file.

Uses the [gpt-3.5-turbo](https://platform.openai.com/docs/guides/chat/chat-completions-beta) model, which is the same model used by ChatGPT (Free Edition), as default.

### Related Projects

[GPTerm implemented in C/C++](https://github.com/Ace-Radom/cGPTerm) by @Ace-Radom

[gpt-term that can call POE API](https://github.com/Lemon-2333/chatgpt-in-terminal-Poe-Api) by @Lemon-2333

## Changelog

### 2023-05-18
Expand Down Expand Up @@ -90,6 +96,8 @@ Released `gpt-term` on [Pypi](https://pypi.org/project/gpt-term/), started versi

2. [Python](https://www.python.org/downloads/) version 3.7 or higher.

**Attention: Try not to use the Python that comes with the system (including Windows 11 app store version and MacOS pre-installed Python), otherwise the gpt-term command will not be found after installation ([#38](https://github.com/xiaoxx970/chatgpt-in-terminal/issues/38))**

## Installation


Expand Down Expand Up @@ -125,6 +133,12 @@ Run with the following command:
gpt-term
```

Or:

```shell
python3 -m gpt_term
```

When entering a question in single-line mode, use `Esc` + `Enter` to start a new line, and use `Enter` to submit the question.

Here are some common shortcut keys (also shortcut keys for the shell):
Expand Down
14 changes: 14 additions & 0 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,12 @@

默认使用 [gpt-3.5-turbo](https://platform.openai.com/docs/guides/chat/chat-completions-beta) 模型,也就是 ChatGPT(免费版) 所使用的模型。

### 相关项目

[C/C++实现的GPTerm](https://github.com/Ace-Radom/cGPTerm) by @Ace-Radom

[可以调用 POE API 的 gpt-term](https://github.com/Lemon-2333/chatgpt-in-terminal-Poe-Api) by @Lemon-2333

## 更新记录

### 2023-05-18
Expand Down Expand Up @@ -93,6 +99,8 @@

2. [Python](https://www.python.org/downloads/) 3.7 或更高版本

**注意:尽量不要使用系统自带的 Python(包括Windows11 的应用商店版 Python 和 MacOS 的预装 Python),否则会出现安装好后gpt-term 命令找不到的情况 ([#38](https://github.com/xiaoxx970/chatgpt-in-terminal/issues/38))**

## 安装

1. 使用 `pip` 安装 `GPT-Term`
Expand Down Expand Up @@ -128,6 +136,12 @@ pip3 install --upgrade gpt-term
gpt-term
```

或者:

```shell
python3 -m gpt_term
```

在默认的单行模式下输入提问时,使用 `Esc` + `Enter` 换行,`Enter` 提交

以下是一些常见的快捷键(同时也是shell的快捷键):
Expand Down
2 changes: 1 addition & 1 deletion gpt_term/locale/gpt_term.zh_CN.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
zh_CN:
welcome: "[dim]你好, 欢迎和 GPT 聊天. 输入`[bright_magenta]/help[/]` 显示可用命令."
exit: "退出中..."
spent_token: "[bright_magenta]已花费的 Token总数:[bold]%{total_tokens_spent}"
spent_token: "[bright_magenta]已花费的 token 总数:[bold]%{total_tokens_spent}"
save_api_key: "将 API Key 保存到配置文件中?"
input_api_key: "未找到 OpenAI API Key, 请输入:"
config_key_to_shell_key: "配置项 `[bright_magenta]%{key_word}[/]` 已设置为 [green]%{val}[/]"
Expand Down

0 comments on commit 1d97114

Please sign in to comment.