Skip to content

Commit a1fff7a

Browse files
committed
Update README for better description
1 parent 1b466c7 commit a1fff7a

File tree

1 file changed

+23
-18
lines changed

1 file changed

+23
-18
lines changed

README.md

Lines changed: 23 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -15,44 +15,49 @@ A simple Python code that connects to OpenAI's ChatGPT and executes the returned
1515
- Interact with your computer using natural language
1616
- Automatically executes the command from the response of ChatGPT
1717
- Good for complex tasks like handling Git and extracting tar files
18-
- 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.**
18+
- No need to search StackOverflow for commands, `AiShell` has got you covered
19+
- `AiShell` simplifies the process of setting up and retrieving tokens or API keys.
20+
- With `AiShell`, you don't have to worry about the technical details.
21+
- Simply install `AiShell`, execute it, and you're ready to go!
2022

2123
## Prerequisites 📚
2224

2325
- Python 3.9+
2426
- ChatGPT Account (or OpenAI Account)
2527

26-
## Installation 🔧
28+
## Getting Started 🚀
29+
30+
To begin using `AiShell`, start by installing it with pip:
2731

2832
```sh
2933
pip install aishell
3034
```
3135

32-
## Getting Started 🚀
33-
34-
Let's just start by printing "Hello World" using AiShell.
36+
Once you've installed `AiShell`, you can start using it right away.
37+
For example, to print "Hello World" using `AiShell`, enter the following command:
3538

3639
```sh
3740
aishell 'print Hello World'
3841
```
3942

4043
## Advanced Settings 🛠
4144

42-
### For those who want to use `Official ChatGPT(GPT3.5-turbo)` or `GPT-3`
45+
By default, `AiShell` is configured to use the reverse-engineered ChatGPT client and retrieve login information from your browser, so you don't need to configure anything to use `AiShell`. However, for those who want to use different models with an OpenAI API Key, you can configure it as follows:
46+
47+
1. Create an account on OpenAI.
48+
1. Go to <https://platform.openai.com/account/api-keys> and copy your API key.
49+
1. Modify or create the `~/.aishell/config.json` file as follows:
4350

44-
1. Create account on OpenAI
45-
1. Go to <https://platform.openai.com/account/api-keys>, Copy API key
46-
1. Modify or create `~/.aishell/config.json` file like following
51+
```json
52+
{
53+
...
54+
"language_model": <language model of your preference>, //"official_chatgpt" or "gpt3"
55+
"openai_api_key": <your OpenAI API key>
56+
}
57+
```
4758

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-
```
59+
Here, you can specify the language model of your preference, such as "official_chatgpt" or "gpt3", and add your OpenAI API key. This will enable AiShell to use the specified language model and API key when executing commands.
5560

5661
## Contributions 💬
5762

58-
Feel free to contribute to AiShell by adding more functionality or fixing bugs.
63+
Feel free to contribute to `AiShell` by adding more functionality or fixing bugs.

0 commit comments

Comments
 (0)