Skip to content

Commit eb344a9

Browse files
committed
Update README.md for automatic login feature
1 parent 0eb963a commit eb344a9

File tree

1 file changed

+20
-22
lines changed

1 file changed

+20
-22
lines changed

README.md

Lines changed: 20 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -16,44 +16,42 @@ A simple Python code that connects to OpenAI's ChatGPT and executes the returned
1616
- Automatically executes the command from the response of ChatGPT
1717
- Good for complex tasks like handling Git and extracting tar files
1818
- No need to search StackOverflow for commands, AiShell has got you covered
19+
- **No need to set up annoying retrieving of tokens or API keys with ChatGPT, as AiShell does it for you. INSTALL IT. EXECUTE IT. DONE.**
20+
21+
## Prerequisites 📚
22+
23+
- Python 3.9+
24+
- ChatGPT Account (or OpenAI Account)
1925

2026
## Installation 🔧
2127

2228
```sh
2329
pip install aishell
2430
```
2531

26-
## Usage 📝
32+
## Getting Started 🚀
33+
34+
Let's just start by printing "Hello World" using AiShell.
2735

2836
```sh
29-
aishell --help
37+
aishell 'print Hello World'
3038
```
3139

32-
## Prerequisites 📚
33-
34-
- Python 3
35-
- OpenAI API Key or ChatGPT Account
36-
37-
## Getting Started 🚀
38-
39-
### For those who want to use reverse-engineered `ChatGPT`
40-
41-
- Permanent Login Method
42-
1. Login on <https://chat.openai.com/>
43-
1. Get your 'accessToken` from <https://chat.openai.com/api/auth/session>
44-
1. Set the API key as an environment variable `CHATGPT_ACCESS_TOKEN`
45-
- Temporary Login Method
46-
1. Just run `aishell <query>`
47-
1. Browser opens up. Login there.
48-
1. Tell AiShell which browser you use.
49-
1. Enjoy AiShell
40+
## Advanced Settings 🛠
5041

5142
### For those who want to use `Official ChatGPT(GPT3.5-turbo)` or `GPT-3`
5243

5344
1. Create account on OpenAI
5445
1. Go to <https://platform.openai.com/account/api-keys>, Copy API key
55-
1. Set the API key as an environment variable `OPENAI_API_KEY`
56-
1. Enjoy AiShell
46+
1. Modify or create `~/.aishell/config.json` file like following
47+
48+
```sh
49+
{
50+
...
51+
"language_model": <language model of your preference>, //"official_chatgpt" or "gpt3"
52+
"openai_api_key": <your openai api key>
53+
}
54+
```
5755

5856
## Contributions 💬
5957

0 commit comments

Comments
 (0)