glen15 / ygk-a

YGK-a: Your Genius, Knowledgeable assistant, An advanced ChatGPT client from your shell.

YGKA 🤖

YGKA is an advanced ChatGPT client for shell that acts as Your Genius Knowledgeable Assistant. YGKA supports Unix/Linux pipelines and requires no setting up of tokens or API keys. Furthermore, if you want to use an OpenAI API key, you can easily configure it.

Key Features 💡

• Supports Unix/Linux pipelines
• Ready to use without setting up tokens or API keys

Prerequisites 📚

• Python 3.9+
• ChatGPT Account (or OpenAI Account)

Getting Started 🚀

To begin using YGKA, install it with pip:

pip install ygka

Once you've installed YGKA, you can start using it right away, like following.

To execute a command, use the following syntax:

ygka "<your command here>"

For example, to ask "hello?" using YGKA, you can use the following command:

ygka "hello?"

You can also use YGKA with Unix pipeline. For example, to ask "what is this file?" while viewing the contents of a text file, you can use the following command:

cat textfile.txt | ygka "what is this file?"

Advanced Settings 🛠

By default, YGKA is configured to use either the official_chatgpt or reverse_engineered_chatgpt language model. To change the language model, modify the ~/.ygka_config.json file as follows:

{
    ...
    "language_model": <language model of your preference>, //"official_chatgpt" or "reverse_engineered_chatgpt"
    "openai_api_key": <your OpenAI API key>
}

Here, you can specify the language model of your preference and add your OpenAI API key.

Inspired By 🎨

• YeonGyu Kim: My name. The project is named after me.
• AiShell: A Natural Language Shell Powered by ChatGPT, is a brother project of YGKA that provides a similar functionality.
• loz: A nodejs version of a GPT3 client that does similar things as YGKA.

Contributions 💬

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