https://github.com/code-yeongyu/AiShell

AiShell: A Natural Language Shell like GitHub Copilot X, Powered by ChatGPT
https://github.com/code-yeongyu/AiShell

aishell artificial-intelligence chatgpt copilot gpt3 openai openai-api python revchatgpt shell

Last synced: 2 months ago
JSON representation

AiShell: A Natural Language Shell like GitHub Copilot X, Powered by ChatGPT

• Host: GitHub
• URL: https://github.com/code-yeongyu/AiShell
• Owner: code-yeongyu
• License: mit
• Created: 2023-02-01T07:59:13.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2023-10-18T12:52:21.000Z (over 1 year ago)
• Last Synced: 2024-11-17T05:02:50.467Z (2 months ago)
• Topics: aishell, artificial-intelligence, chatgpt, copilot, gpt3, openai, openai-api, python, revchatgpt, shell
• Language: Python
• Homepage:
• Size: 1.56 MB
• Stars: 151
• Watchers: 6
• Forks: 14
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# AiShell 🤖

[![codecov](https://codecov.io/gh/code-yeongyu/AiShell/branch/master/graph/badge.svg?token=MR72XGUQWJ)](https://codecov.io/gh/code-yeongyu/AiShell)

[![Release Package to PyPI](https://github.com/code-yeongyu/AiShell/actions/workflows/release.yml/badge.svg)](https://github.com/code-yeongyu/AiShell/actions/workflows/release.yml)

[![PyPI version](https://badge.fury.io/py/aishell.svg)](https://badge.fury.io/py/aishell)

[![Downloads](https://static.pepy.tech/badge/aishell)](https://pepy.tech/project/aishell)

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

If you are interested in these projects, please checkout AiShell's brother project: [YGK-a](https://github.com/code-yeongyu/YGK-a). YGK-a is a client for the ChatGPT from your terminal, and also supports unix/linux pipelines.

## Demo

![Demo](https://raw.githubusercontent.com/code-yeongyu/AiShell/master/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

- `AiShell` simplifies the process of setting up and retrieving tokens or API keys.

  - With `AiShell`, you don't have to worry about the technical details.

  - Simply install `AiShell`, execute it, and you're ready to go!

## Prerequisites 📚

- Python 3.9+

- ChatGPT Account (or OpenAI Account)

## Getting Started 🚀

To begin using `AiShell`, start by installing it with pip:

```sh

pip install aishell

```

Or you can use pipx:

```sh

pipx install aishell

```

Once you've installed `AiShell`, you can start using it right away.

For example, to print "Hello World" using `AiShell`, enter the following command:

```sh

aishell 'print Hello World'

```

## Advanced Settings 🛠

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:

1. Create an account on OpenAI.

1. Go to  and copy your API key.

1. Modify or create the `~/.ygka_openai_config.json` file as follows:

  ```json

  {

      ...

      "language_model": "official_chatgpt",

      "openai_api_key": ""

  }

  ```

Here, you can add your OpenAI API key. This will enable AiShell to use the official chatgpt api and the API key when executing commands.

## Contributions 💬

Feel free to contribute to `AiShell` by adding more functionality or fixing bugs.