Giter VIP home page Giter VIP logo

aishell's Introduction

AiShell ๐Ÿค–

codecov Release Package to PyPI PyPI version Downloads

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. YGK-a is a client for the ChatGPT from your terminal, and also supports unix/linux pipelines.

Demo

Demo

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:

pip install aishell

Or you can use pipx:

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:

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.
  2. Go to https://platform.openai.com/account/api-keys and copy your API key.
  3. Modify or create the ~/.ygka_openai_config.json file as follows:
{
    ...
    "language_model": "official_chatgpt",
    "openai_api_key": "<your 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.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.