Skip to content

Commit d065f3e

Browse files
committed
chore: update README
1 parent 885026b commit d065f3e

File tree

2 files changed

+33
-8
lines changed

2 files changed

+33
-8
lines changed

README-cn.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Aoi (葵)
22

3-
ChatGPT 驱动的 Ghost in the Shell
3+
OpenAI 驱动的 Ghost in the Shell
44

5-
Aoi 是由 ChatGPT 驱动的基于人工智能的对话代理程序。使用 Aoi,可以在终端中与 AI 进行自然语言对话,它能够理解您的查询并执行适当的命令。
5+
使用 Aoi,可以在终端中与 AI 进行自然语言对话,它能够理解您的查询并执行适当的命令。
66

77
## 功能
88
Aoi 可以用作 ChatGPT 的终端版本,此外,Aoi 还带有几个内置功能提高使用效率:
@@ -21,20 +21,33 @@ Aoi 是由 ChatGPT 驱动的基于人工智能的对话代理程序。使用 Aoi
2121
```bash
2222
go install github.com/shellfly/aoi@latest
2323
```
24+
### OpenAI API Key
2425
将 OpenAI API 密钥设置为环境变量,然后运行 aoi 命令。
2526

2627
```bash
2728

2829
export OPENAI_API_KEY=<your_api_key>
30+
2931
aoi
3032
```
33+
34+
### OpenAI API Base URL
3135
如有需要,也可自定义 OpenAI API BASE URL 为环境变量。
3236

3337
```bash
34-
3538
export OPENAI_API_BASE_URL=<your_custom_api_base_url>
3639
```
3740

41+
### Azure OpenAI
42+
使用Azure的环境变量,并且传递`azure.deployment`参数来使用Azure OpenAI 服务
43+
44+
```
45+
export OPENAI_API_KEY={azure openai secret}
46+
export OPENAI_API_BASE_URL={azure openai endpoint}
47+
48+
aoi -azure.deployment {model deployment name}
49+
```
50+
3851
## 演示
3952
### shell
4053
[![shell](/doc/shell.gif)](https://asciinema.org/a/XjCGaMNf8Qp2nQ1UDlehjm5AN)

README.md

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33

44
[中文说明](/README-cn.md)
55

6-
Ghost in the Shell powered by ChatGPT
6+
Ghost in the Shell powered by OpenAI.
77

8-
**Aoi** is an AI-based conversational agent powered by ChatGPT. With Aoi, you can have natural language conversations with an AI in the terminal that can understand your queries and execute appropriate commands.
8+
With Aoi, you can have natural language conversations with an AI in the terminal that can understand your queries and execute appropriate commands.
99

1010
## Features
1111
You can use Aoi as a terminal version of ChatGPT, Besides, Aoi comes with several built-in features that can help you be more productive:
@@ -26,17 +26,29 @@ You can download Aoi from the GitHub [release page](https://github.com/shellfly/
2626
go install github.com/shellfly/aoi@latest
2727
```
2828

29+
### OpenAI API Key
2930
Set your OpenAI API key as an environment variable, and then run the `aoi` command.
3031

3132
```bash
32-
export OPENAI_API_KEY=<your_api_key>
33+
export OPENAI_API_KEY={your_api_key}
34+
3335
aoi
3436
```
35-
If necessary, you can also customize the OpenAI API BASE URL as an environment variable.
37+
38+
### OpenAI API Base URL
39+
If needed, you can also customize the OpenAI API BASE URL as an environment variable.
3640

3741
```bash
42+
export OPENAI_API_BASE_URL={your_custom_api_base_url}
43+
```
44+
45+
### Azure OpenAI
46+
Set Azure environment variables and pass the `azure.deployment` to use Azure OpenAI service
47+
```
48+
export OPENAI_API_KEY={azure openai secret}
49+
export OPENAI_API_BASE_URL={azure openai endpoint}
3850
39-
export OPENAI_API_BASE_URL=<your_custom_api_base_url>
51+
aoi -azure.deployment {model deployment name}
4052
```
4153

4254
## Demos

0 commit comments

Comments
 (0)