Skip to content

Commit

Permalink
Merge pull request #20 from code-yeongyu/feature/improve-readme
Browse files Browse the repository at this point in the history
  • Loading branch information
code-yeongyu authored Mar 2, 2023
2 parents 3081a8e + 8c3e3de commit 3591b77
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 10 deletions.
29 changes: 19 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,17 @@

A simple Python code that connects to OpenAI's ChatGPT and executes the returned results.

## Demo

![Demo](images/example.gif)

## Key Features 💡

- Interact with your computer using natural language
- Automatically executes the command from the response of ChatGPT
- Good for complex tasks like handling Git and extracting tar files
- No need to search StackOverflow for commands, AiShell has got you covered

### Simple Utility commands 🛠

[![utility](https://asciinema.org/a/556670.svg)](https://asciinema.org/a/556670?speed=5)

### A powerful git assistant 💪🏻👨‍💻💻

[![git assistant](https://asciinema.org/a/556677.svg)](https://asciinema.org/a/556677?speed=5)

## Installation 🔧

```sh
Expand All @@ -30,7 +26,7 @@ pip install aishell
## Usage 📝

```sh
python -m aishell --help
aishell --help
```

## Prerequisites 📚
Expand All @@ -41,10 +37,23 @@ python -m aishell --help

## Getting Started 🚀

### For those who want to use reverse-engineered `ChatGPT`

1. Login on <https://chat.openai.com/>
1. Get your 'accessToken` from <https://chat.openai.com/api/auth/session>
1. `export CHATGPT_ACCESS_KEY=<your access token>`
1. Enjoy AiShell

### For those who want to use `GPT-3`

1. Create account on OpenAI
1. Go to <https://platform.openai.com/account/api-keys>, Copy API key
1. Set the API key as an environment variable `OPENAI_API_KEY` or inject it directly into the code by editing it.
1. [Install](#installation)
1. Enjoy AiShell

### For those who want to use Official ChatGPT API `gpt-3.5-turbo`

- Currently not supported, but soon will be supported!

## Contributions 💬

Expand Down
Binary file added images/example.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 3591b77

Please sign in to comment.