You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+23-18Lines changed: 23 additions & 18 deletions
Original file line number
Diff line number
Diff line change
@@ -15,44 +15,49 @@ A simple Python code that connects to OpenAI's ChatGPT and executes the returned
15
15
- Interact with your computer using natural language
16
16
- Automatically executes the command from the response of ChatGPT
17
17
- 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!
20
22
21
23
## Prerequisites 📚
22
24
23
25
- Python 3.9+
24
26
- ChatGPT Account (or OpenAI Account)
25
27
26
-
## Installation 🔧
28
+
## Getting Started 🚀
29
+
30
+
To begin using `AiShell`, start by installing it with pip:
27
31
28
32
```sh
29
33
pip install aishell
30
34
```
31
35
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:
35
38
36
39
```sh
37
40
aishell 'print Hello World'
38
41
```
39
42
40
43
## Advanced Settings 🛠
41
44
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:
43
50
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
+
```
47
58
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.
55
60
56
61
## Contributions 💬
57
62
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